📝 Update source examples to use new JSON Schema examples field (#9776)

* 📝 Update source examples to use new JSON Schema examples field

* ✅ Update tests for JSON Schema examples

* 📝 Update highlights in JSON Schema examples

docs/en/docs/tutorial/schema-extra-example.md

@@ -116,19 +116,19 @@ You can of course also pass multiple `examples`:
 
 === "Python 3.10+"
 
-    ```Python hl_lines="23-49"
+    ```Python hl_lines="23-38"
     {!> ../../../docs_src/schema_extra_example/tutorial004_an_py310.py!}
     ```
 
 === "Python 3.9+"
 
-    ```Python hl_lines="23-49"
+    ```Python hl_lines="23-38"
     {!> ../../../docs_src/schema_extra_example/tutorial004_an_py39.py!}
     ```
 
 === "Python 3.6+"
 
-    ```Python hl_lines="24-50"
+    ```Python hl_lines="24-39"
     {!> ../../../docs_src/schema_extra_example/tutorial004_an.py!}
     ```
 
@@ -137,7 +137,7 @@ You can of course also pass multiple `examples`:
     !!! tip
         Prefer to use the `Annotated` version if possible.
 
-    ```Python hl_lines="19-45"
+    ```Python hl_lines="19-34"
     {!> ../../../docs_src/schema_extra_example/tutorial004_py310.py!}
     ```
 
@@ -146,7 +146,7 @@ You can of course also pass multiple `examples`:
     !!! tip
         Prefer to use the `Annotated` version if possible.
 
-    ```Python hl_lines="21-47"
+    ```Python hl_lines="21-36"
     {!> ../../../docs_src/schema_extra_example/tutorial004.py!}
     ```
 

docs_src/schema_extra_example/tutorial004.py

@@ -20,30 +20,19 @@ async def update_item(
     item: Item = Body(
         examples=[
             {
-                "summary": "A normal example",
-                "description": "A **normal** item works correctly.",
-                "value": {
                 "name": "Foo",
                 "description": "A very nice Item",
                 "price": 35.4,
                 "tax": 3.2,
             },
-            },
             {
-                "summary": "An example with converted data",
-                "description": "FastAPI can convert price `strings` to actual `numbers` automatically",
-                "value": {
                 "name": "Bar",
                 "price": "35.4",
             },
-            },
             {
-                "summary": "Invalid data is rejected with an error",
-                "value": {
                 "name": "Baz",
                 "price": "thirty five point four",
             },
-            },
         ],
     ),
 ):

docs_src/schema_extra_example/tutorial004_an.py

@@ -23,30 +23,19 @@ async def update_item(
         Body(
             examples=[
                 {
-                    "summary": "A normal example",
-                    "description": "A **normal** item works correctly.",
-                    "value": {
                     "name": "Foo",
                     "description": "A very nice Item",
                     "price": 35.4,
                     "tax": 3.2,
                 },
-                },
                 {
-                    "summary": "An example with converted data",
-                    "description": "FastAPI can convert price `strings` to actual `numbers` automatically",
-                    "value": {
                     "name": "Bar",
                     "price": "35.4",
                 },
-                },
                 {
-                    "summary": "Invalid data is rejected with an error",
-                    "value": {
                     "name": "Baz",
                     "price": "thirty five point four",
                 },
-                },
             ],
         ),
     ],

docs_src/schema_extra_example/tutorial004_an_py310.py

@@ -22,30 +22,19 @@ async def update_item(
         Body(
             examples=[
                 {
-                    "summary": "A normal example",
-                    "description": "A **normal** item works correctly.",
-                    "value": {
                     "name": "Foo",
                     "description": "A very nice Item",
                     "price": 35.4,
                     "tax": 3.2,
                 },
-                },
                 {
-                    "summary": "An example with converted data",
-                    "description": "FastAPI can convert price `strings` to actual `numbers` automatically",
-                    "value": {
                     "name": "Bar",
                     "price": "35.4",
                 },
-                },
                 {
-                    "summary": "Invalid data is rejected with an error",
-                    "value": {
                     "name": "Baz",
                     "price": "thirty five point four",
                 },
-                },
             ],
         ),
     ],

docs_src/schema_extra_example/tutorial004_an_py39.py

@@ -22,30 +22,19 @@ async def update_item(
         Body(
             examples=[
                 {
-                    "summary": "A normal example",
-                    "description": "A **normal** item works correctly.",
-                    "value": {
                     "name": "Foo",
                     "description": "A very nice Item",
                     "price": 35.4,
                     "tax": 3.2,
                 },
-                },
                 {
-                    "summary": "An example with converted data",
-                    "description": "FastAPI can convert price `strings` to actual `numbers` automatically",
-                    "value": {
                     "name": "Bar",
                     "price": "35.4",
                 },
-                },
                 {
-                    "summary": "Invalid data is rejected with an error",
-                    "value": {
                     "name": "Baz",
                     "price": "thirty five point four",
                 },
-                },
             ],
         ),
     ],

docs_src/schema_extra_example/tutorial004_py310.py

@@ -18,30 +18,19 @@ async def update_item(
     item: Item = Body(
         examples=[
             {
-                "summary": "A normal example",
-                "description": "A **normal** item works correctly.",
-                "value": {
                 "name": "Foo",
                 "description": "A very nice Item",
                 "price": 35.4,
                 "tax": 3.2,
             },
-            },
             {
-                "summary": "An example with converted data",
-                "description": "FastAPI can convert price `strings` to actual `numbers` automatically",
-                "value": {
                 "name": "Bar",
                 "price": "35.4",
             },
-            },
             {
-                "summary": "Invalid data is rejected with an error",
-                "value": {
                 "name": "Baz",
                 "price": "thirty five point four",
             },
-            },
         ],
     ),
 ):

tests/test_tutorial/test_schema_extra_example/test_tutorial004.py

@@ -46,27 +46,16 @@ def test_openapi_schema():
                                     "title": "Item",
                                     "examples": [
                                         {
-                                            "summary": "A normal example",
-                                            "description": "A **normal** item works correctly.",
-                                            "value": {
                                             "name": "Foo",
                                             "description": "A very nice Item",
                                             "price": 35.4,
                                             "tax": 3.2,
                                         },
-                                        },
+                                        {"name": "Bar", "price": "35.4"},
-                                        {
-                                            "summary": "An example with converted data",
-                                            "description": "FastAPI can convert price `strings` to actual `numbers` automatically",
-                                            "value": {"name": "Bar", "price": "35.4"},
-                                        },
                                         {
-                                            "summary": "Invalid data is rejected with an error",
-                                            "value": {
                                             "name": "Baz",
                                             "price": "thirty five point four",
                                         },
-                                        },
                                     ],
                                 }
                             }

tests/test_tutorial/test_schema_extra_example/test_tutorial004_an.py

@@ -46,27 +46,16 @@ def test_openapi_schema():
                                     "title": "Item",
                                     "examples": [
                                         {
-                                            "summary": "A normal example",
-                                            "description": "A **normal** item works correctly.",
-                                            "value": {
                                             "name": "Foo",
                                             "description": "A very nice Item",
                                             "price": 35.4,
                                             "tax": 3.2,
                                         },
-                                        },
+                                        {"name": "Bar", "price": "35.4"},
-                                        {
-                                            "summary": "An example with converted data",
-                                            "description": "FastAPI can convert price `strings` to actual `numbers` automatically",
-                                            "value": {"name": "Bar", "price": "35.4"},
-                                        },
                                         {
-                                            "summary": "Invalid data is rejected with an error",
-                                            "value": {
                                             "name": "Baz",
                                             "price": "thirty five point four",
                                         },
-                                        },
                                     ],
                                 }
                             }

tests/test_tutorial/test_schema_extra_example/test_tutorial004_an_py310.py

@@ -55,27 +55,16 @@ def test_openapi_schema(client: TestClient):
                                     "title": "Item",
                                     "examples": [
                                         {
-                                            "summary": "A normal example",
-                                            "description": "A **normal** item works correctly.",
-                                            "value": {
                                             "name": "Foo",
                                             "description": "A very nice Item",
                                             "price": 35.4,
                                             "tax": 3.2,
                                         },
-                                        },
+                                        {"name": "Bar", "price": "35.4"},
-                                        {
-                                            "summary": "An example with converted data",
-                                            "description": "FastAPI can convert price `strings` to actual `numbers` automatically",
-                                            "value": {"name": "Bar", "price": "35.4"},
-                                        },
                                         {
-                                            "summary": "Invalid data is rejected with an error",
-                                            "value": {
                                             "name": "Baz",
                                             "price": "thirty five point four",
                                         },
-                                        },
                                     ],
                                 }
                             }

tests/test_tutorial/test_schema_extra_example/test_tutorial004_an_py39.py

@@ -55,27 +55,16 @@ def test_openapi_schema(client: TestClient):
                                     "title": "Item",
                                     "examples": [
                                         {
-                                            "summary": "A normal example",
-                                            "description": "A **normal** item works correctly.",
-                                            "value": {
                                             "name": "Foo",
                                             "description": "A very nice Item",
                                             "price": 35.4,
                                             "tax": 3.2,
                                         },
-                                        },
+                                        {"name": "Bar", "price": "35.4"},
-                                        {
-                                            "summary": "An example with converted data",
-                                            "description": "FastAPI can convert price `strings` to actual `numbers` automatically",
-                                            "value": {"name": "Bar", "price": "35.4"},
-                                        },
                                         {
-                                            "summary": "Invalid data is rejected with an error",
-                                            "value": {
                                             "name": "Baz",
                                             "price": "thirty five point four",
                                         },
-                                        },
                                     ],
                                 }
                             }

tests/test_tutorial/test_schema_extra_example/test_tutorial004_py310.py

@@ -55,27 +55,16 @@ def test_openapi_schema(client: TestClient):
                                     "title": "Item",
                                     "examples": [
                                         {
-                                            "summary": "A normal example",
-                                            "description": "A **normal** item works correctly.",
-                                            "value": {
                                             "name": "Foo",
                                             "description": "A very nice Item",
                                             "price": 35.4,
                                             "tax": 3.2,
                                         },
-                                        },
+                                        {"name": "Bar", "price": "35.4"},
-                                        {
-                                            "summary": "An example with converted data",
-                                            "description": "FastAPI can convert price `strings` to actual `numbers` automatically",
-                                            "value": {"name": "Bar", "price": "35.4"},
-                                        },
                                         {
-                                            "summary": "Invalid data is rejected with an error",
-                                            "value": {
                                             "name": "Baz",
                                             "price": "thirty five point four",
                                         },
-                                        },
                                     ],
                                 }
                             }