docs_src/schema_extra_example/tutorial002_py310.py

from fastapi import FastAPI
from pydantic import BaseModel, Field

app = FastAPI()


class Item(BaseModel):
    name: str = Field(examples=["Foo"])
    description: str | None = Field(default=None, examples=["A very nice Item"])
    price: float = Field(examples=[35.4])
    tax: 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 and tests for Python 3.9 and Python 3.10 (#3712) Co-authored-by: Thomas Grainger <tagrain@gmail.com> 2022-01-07 15:11:31 +01: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: str \| None = Field(default=None, examples=["A very nice Item"])`
			`price: float = Field(examples=[35.4])`
			`tax: float \| None = Field(default=None, examples=[3.2])`
✨ Add docs and tests for Python 3.9 and Python 3.10 (#3712) Co-authored-by: Thomas Grainger <tagrain@gmail.com> 2022-01-07 15:11:31 +01:00

			`@app.put("/items/{item_id}")`
			`async def update_item(item_id: int, item: Item):`
			`results = {"item_id": item_id, "item": item}`
			`return results`