- Sort Score
- Result 10 results
- Languages All
Results 1 - 10 of 11 for openapi_examples (0.09 sec)
-
fastapi/params.py
category=FastAPIDeprecationWarning, stacklevel=4, ) self.example = example self.include_in_schema = include_in_schema self.openapi_examples = openapi_examples kwargs = dict( default=default, default_factory=default_factory, alias=alias, title=title, description=description, gt=gt,Registered: Sun Dec 28 07:19:09 UTC 2025 - Last Modified: Sat Dec 27 12:54:56 UTC 2025 - 26.3K bytes - Viewed (0) -
docs/en/docs/tutorial/schema-extra-example.md
This doesn't go inside of each JSON Schema contained in OpenAPI, this goes outside, in the *path operation* directly. ### Using the `openapi_examples` Parameter { #using-the-openapi-examples-parameter } You can declare the OpenAPI-specific `examples` in FastAPI with the parameter `openapi_examples` for: * `Path()` * `Query()` * `Header()` * `Cookie()` * `Body()` * `Form()` * `File()`
Registered: Sun Dec 28 07:19:09 UTC 2025 - Last Modified: Sat Dec 20 15:55:38 UTC 2025 - 8.9K bytes - Viewed (0) -
fastapi/param_functions.py
multiple_of=multiple_of, allow_inf_nan=allow_inf_nan, max_digits=max_digits, decimal_places=decimal_places, example=example, examples=examples, openapi_examples=openapi_examples, deprecated=deprecated, include_in_schema=include_in_schema, json_schema_extra=json_schema_extra, **extra, ) def Query( # noqa: N802Registered: Sun Dec 28 07:19:09 UTC 2025 - Last Modified: Sat Dec 27 12:54:56 UTC 2025 - 63K bytes - Viewed (0) -
docs/de/docs/tutorial/schema-extra-example.md
Dies erfolgt nicht innerhalb jedes in OpenAPI enthaltenen JSON-Schemas, sondern außerhalb, in der *Pfadoperation*. ### Verwendung des Parameters `openapi_examples` { #using-the-openapi-examples-parameter } Sie können die OpenAPI-spezifischen `examples` in FastAPI mit dem Parameter `openapi_examples` deklarieren, für: * `Path()` * `Query()` * `Header()` * `Cookie()` * `Body()` * `Form()` * `File()`Registered: Sun Dec 28 07:19:09 UTC 2025 - Last Modified: Wed Dec 24 10:28:19 UTC 2025 - 10.6K bytes - Viewed (0) -
docs/pt/docs/tutorial/schema-extra-example.md
Isso não vai dentro de cada JSON Schema contido no OpenAPI, vai fora, diretamente na *operação de rota*. ### Usando o parâmetro `openapi_examples` { #using-the-openapi-examples-parameter } Você pode declarar o `examples` específico do OpenAPI no FastAPI com o parâmetro `openapi_examples` para: * `Path()` * `Query()` * `Header()` * `Cookie()` * `Body()` * `Form()` * `File()`Registered: Sun Dec 28 07:19:09 UTC 2025 - Last Modified: Wed Nov 12 16:23:57 UTC 2025 - 10.3K bytes - Viewed (0) -
docs/es/docs/tutorial/schema-extra-example.md
Esto no va dentro de cada JSON Schema contenido en OpenAPI, esto va afuera, directamente en la *path operation*. ### Usando el Parámetro `openapi_examples` { #using-the-openapi-examples-parameter } Puedes declarar los `examples` específicos de OpenAPI en FastAPI con el parámetro `openapi_examples` para: * `Path()` * `Query()` * `Header()` * `Cookie()` * `Body()` * `Form()` * `File()`Registered: Sun Dec 28 07:19:09 UTC 2025 - Last Modified: Tue Dec 16 16:33:45 UTC 2025 - 10.3K bytes - Viewed (0) -
tests/test_openapi_examples.py
class Item(BaseModel): data: str @app.post("/examples/") def examples( item: Item = Body( examples=[ {"data": "Data in Body examples, example1"}, ], openapi_examples={ "Example One": { "summary": "Example One Summary", "description": "Example One Description", "value": {"data": "Data in Body examples, example1"},
Registered: Sun Dec 28 07:19:09 UTC 2025 - Last Modified: Sat Dec 27 18:19:10 UTC 2025 - 15.1K bytes - Viewed (0) -
fastapi/openapi/utils.py
if field_info.description: parameter["description"] = field_info.description openapi_examples = getattr(field_info, "openapi_examples", None) example = getattr(field_info, "example", None) if openapi_examples: parameter["examples"] = jsonable_encoder(openapi_examples) elif example != Undefined: parameter["example"] = jsonable_encoder(example)Registered: Sun Dec 28 07:19:09 UTC 2025 - Last Modified: Sat Dec 27 12:54:56 UTC 2025 - 23.2K bytes - Viewed (0) -
docs/ru/docs/tutorial/schema-extra-example.md
### Использование параметра `openapi_examples` { #using-the-openapi-examples-parameter } Вы можете объявлять специфические для OpenAPI `examples` в FastAPI с помощью параметра `openapi_examples` для: * `Path()` * `Query()` * `Header()` * `Cookie()` * `Body()` * `Form()` * `File()`Registered: Sun Dec 28 07:19:09 UTC 2025 - Last Modified: Tue Sep 30 11:24:39 UTC 2025 - 14.8K bytes - Viewed (0) -
docs_src/schema_extra_example/tutorial005_py39.py
Registered: Sun Dec 28 07:19:09 UTC 2025 - Last Modified: Wed Dec 17 20:41:43 UTC 2025 - 1.4K bytes - Viewed (0)