docs_src/schema_extra_example/tutorial002_py39.py

from typing import Union

from fastapi import FastAPI
from pydantic import BaseModel, Field

app = FastAPI()


class Item(BaseModel):
    name: str = Field(examples=["Foo"])
    description: Union[str, None] = Field(default=None, examples=["A very nice Item"])
    price: float = Field(examples=[35.4])
    tax: Union[float, None] = Field(default=None, examples=[3.2])


@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Item):
    results = {"item_id": item_id, "item": item}
    return results
📝 Add docs recommending `Union` over `Optional` and migrate source examples (#4908) * 📝 Add docs recommending Union over Optional * 📝 Update docs recommending Union over Optional * 📝 Update source examples for docs, recommend Union over Optional * 📝 Update highlighted lines with updated source examples * 📝 Update highlighted lines in Markdown with recent code changes * 📝 Update docs, use Union instead of Optional * ♻️ Update source examples to recommend Union over Optional * 🎨 Update highlighted code in Markdown after moving from Optional to Union 2022-05-14 06:59:59 -05:00			`from typing import Union`
📝 Use Optional in docs (#1644) * Updated .py files with Optional tag (up to body_nested_models) * Update optionals * docs_src/ all updates, few I was unsure of * Updated markdown files with Optional param * es: Add Optional typing to index.md * Last of markdown files updated with Optional param * Update highlight lines * it: Add Optional typings * README.md: Update with Optional typings * Update more highlight increments * Update highlights * schema-extra-example.md: Update highlights * updating highlighting on website to reflect .py changes * Update highlighting for query-params & response-directly * Address PR comments * Get rid of unnecessary comment * ⏪ Revert Optional in Chinese docs as it probably also requires changes in text * 🎨 Apply format * ⏪ Revert modified example * ♻️ Simplify example in docs * 📝 Update OpenAPI callback example to use Optional * ✨ Add Optional types to tests * 📝 Update docs about query params, default to using Optional * 🎨 Update code examples line highlighting * 📝 Update nested models docs to use "type parameters" instead of "subtypes" * 📝 Add notes about FastAPI usage of None including: = None and = Query(None) and clarify relationship with Optional[str] * 📝 Add note about response_model_by_alias * ♻️ Simplify query param list example * 🔥 Remove test for removed example * ✅ Update test for updated example Co-authored-by: Christopher Nguyen <chrisngyn99@gmail.com> Co-authored-by: yk396 <yk396@cornell.edu> Co-authored-by: Kai Chen <kaichen120@gmail.com> 2020-06-28 20:13:30 +02:00
:memo: Add documentation of example kwarg of Field (#1106) * Add documentation of example kwarg of Field * :memo: Update info about schema examples * :truck: Move example file to new directory Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com> 2020-03-29 21:43:31 +02:00			`from fastapi import FastAPI`
			`from pydantic import BaseModel, Field`

			`app = FastAPI()`


			`class Item(BaseModel):`
✨ Add support for OpenAPI 3.1.0 (#9770) * ✨ Update OpenAPI models for JSON Schema 2020-12 and OpenAPI 3.1.0 * ✨ Add support for summary and webhooks * ✨ Update JSON Schema for UploadFiles * ⏪️ Revert making paths optional, to ensure always correctness * ⏪️ Keep UploadFile as format: binary for compatibility with the rest of Pydantic bytes fields in v1 * ✨ Update version of OpenAPI generated to 3.1.0 * ✨ Update the version of Swagger UI * 📝 Update docs about extending OpenAPI * 📝 Update docs and links to refer to OpenAPI 3.1.0 * ✨ Update logic for handling webhooks * ♻️ Update parameter functions and classes, deprecate example and make examples the main field * ✅ Update tests for OpenAPI 3.1.0 * 📝 Update examples for OpenAPI metadata * ✅ Add and update tests for OpenAPI metadata * 📝 Add source example for webhooks * 📝 Update docs for metadata * 📝 Update docs for Schema extra * 📝 Add docs for webhooks * 🔧 Add webhooks docs to MkDocs * ✅ Update tests for extending OpenAPI * ✅ Add tests for webhooks * ♻️ Refactor generation of OpenAPI and JSON Schema with params * 📝 Update source examples for field examples * ✅ Update tests for examples * ➕ Make sure the minimum version of typing-extensions installed has deprecated() (already a dependency of Pydantic) * ✏️ Fix typo in Webhooks example code * 🔥 Remove commented out code of removed nullable field * 🗑️ Add deprecation warnings for example argument * ✅ Update tests to check for deprecation warnings * ✅ Add test for webhooks with security schemes, for coverage * 🍱 Update image for metadata, with new summary * 🍱 Add docs image for Webhooks * 📝 Update docs for webhooks, add docs UI image 2023-06-30 20:25:16 +02:00			`name: str = Field(examples=["Foo"])`
			`description: Union[str, None] = Field(default=None, examples=["A very nice Item"])`
			`price: float = Field(examples=[35.4])`
			`tax: Union[float, None] = Field(default=None, examples=[3.2])`
:memo: Add documentation of example kwarg of Field (#1106) * Add documentation of example kwarg of Field * :memo: Update info about schema examples * :truck: Move example file to new directory Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com> 2020-03-29 21:43:31 +02:00

			`@app.put("/items/{item_id}")`
📝 Remove , from functions where it's not needed #1234 (#1239) Fix for - [FEATURE] Remove , where it's not needed #1234 🔥 Remove unnecessary arg , 🎨 Update docs format highlight lines Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com> 2020-06-13 01:11:44 +05:30			`async def update_item(item_id: int, item: Item):`
:memo: Add documentation of example kwarg of Field (#1106) * Add documentation of example kwarg of Field * :memo: Update info about schema examples * :truck: Move example file to new directory Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com> 2020-03-29 21:43:31 +02:00			`results = {"item_id": item_id, "item": item}`
			`return results`