Files
fastapi/docs/tutorial/path-operation-advanced-configuration.md
Sebastián Ramírez 00e2e544c7 ♻️ Re-format tutorials, files names and tests
for tutorial files
2018-12-18 21:59:06 +04:00

686 B

OpenAPI operationId

!!! danger If you are not an "expert" in OpenAPI, you probably don't need this.

You can set the OpenAPI operationId to be used in your path operation with the parameter operation_id.

You would have to make sure that it is unique for each operation.

{!./tutorial/src/path_operation_advanced_configuration/tutorial001.py!}

Exclude from OpenAPI

To exclude a path operation from the generated OpenAPI schema (and thus, from the automatic documentation systems), use the parameter include_in_schema and set it to False;

{!./tutorial/src/path_operation_advanced_configuration/tutorial002.py!}