mirror/fastapi
1
0 Fork 0
mirror of https://github.com/fastapi/fastapi.git synced 2026-10-24 10:49:21 -04:00
Code Issues Packages Projects Releases Wiki Activity

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

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

* ✅ Update tests for JSON Schema examples

* 📝 Update highlights in JSON Schema examples
This commit is contained in:
Sebastián Ramírez authored and GitHub committed 2023-07-01 18:43:29 +02:00
1 parent 983f1d34db
commit 4d83f984cc
11 files changed
+80 -190
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

tests/test_tutorial/test_schema_extra_example/test_tutorial004.py
+7 -18
View File
@@ -46,26 +46,15 @@ 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": "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",
},
"name": "Baz",
"price": "thirty five point four",
},
],
}
tests/test_tutorial/test_schema_extra_example/test_tutorial004_an.py
+7 -18
View File
@@ -46,26 +46,15 @@ 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": "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",
},
"name": "Baz",
"price": "thirty five point four",
},
],
}
tests/test_tutorial/test_schema_extra_example/test_tutorial004_an_py310.py
+7 -18
View File
@@ -55,26 +55,15 @@ 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": "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",
},
"name": "Baz",
"price": "thirty five point four",
},
],
}
tests/test_tutorial/test_schema_extra_example/test_tutorial004_an_py39.py
+7 -18
View File
@@ -55,26 +55,15 @@ 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": "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",
},
"name": "Baz",
"price": "thirty five point four",
},
],
}
tests/test_tutorial/test_schema_extra_example/test_tutorial004_py310.py
+7 -18
View File
@@ -55,26 +55,15 @@ 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": "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",
},
"name": "Baz",
"price": "thirty five point four",
},
],
}