📝 Update ModelRead to ModelPublic documentation and examples (#885)

Co-authored-by: Sebastián Ramírez <tiangolo@gmail.com>
This commit is contained in:
Esteban Maya
2024-04-08 18:07:48 -05:00
committed by GitHub
parent fa79856a4b
commit 1eb40b1f33
68 changed files with 427 additions and 427 deletions

View File

@ -99,7 +99,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -136,7 +136,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -172,7 +172,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -244,7 +244,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -297,8 +297,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -102,7 +102,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -139,7 +139,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -175,7 +175,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -247,7 +247,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -300,8 +300,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -102,7 +102,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -139,7 +139,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -175,7 +175,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -247,7 +247,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -300,8 +300,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -104,7 +104,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -141,7 +141,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -177,7 +177,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -230,8 +230,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -107,7 +107,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -144,7 +144,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -180,7 +180,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -233,8 +233,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -107,7 +107,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -144,7 +144,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -180,7 +180,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -233,8 +233,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -74,7 +74,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -101,7 +101,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -154,8 +154,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["id", "name", "secret_name"],
"type": "object",
"properties": {

View File

@ -76,7 +76,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -103,7 +103,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -156,8 +156,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["id", "name", "secret_name"],
"type": "object",
"properties": {

View File

@ -77,7 +77,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -104,7 +104,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -157,8 +157,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["id", "name", "secret_name"],
"type": "object",
"properties": {

View File

@ -74,7 +74,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -101,7 +101,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -154,8 +154,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -77,7 +77,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -104,7 +104,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -157,8 +157,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -77,7 +77,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -104,7 +104,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -157,8 +157,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -59,7 +59,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -86,7 +86,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -122,7 +122,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -175,8 +175,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -62,7 +62,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -89,7 +89,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -125,7 +125,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -178,8 +178,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -62,7 +62,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -89,7 +89,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -125,7 +125,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -178,8 +178,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -147,7 +147,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -184,7 +184,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -220,7 +220,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroReadWithTeam"
"$ref": "#/components/schemas/HeroPublicWithTeam"
}
}
},
@ -292,7 +292,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -346,7 +346,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Teams Teams Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
},
}
}
@ -383,7 +383,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
}
}
},
@ -419,7 +419,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamReadWithHeroes"
"$ref": "#/components/schemas/TeamPublicWithHeroes"
}
}
},
@ -491,7 +491,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
}
}
},
@ -554,8 +554,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {
@ -584,8 +584,8 @@ def test_tutorial(clear_sqlmodel):
"id": {"title": "Id", "type": "integer"},
},
},
"HeroReadWithTeam": {
"title": "HeroReadWithTeam",
"HeroPublicWithTeam": {
"title": "HeroPublicWithTeam",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {
@ -615,14 +615,14 @@ def test_tutorial(clear_sqlmodel):
"team": IsDict(
{
"anyOf": [
{"$ref": "#/components/schemas/TeamRead"},
{"$ref": "#/components/schemas/TeamPublic"},
{"type": "null"},
]
}
)
| IsDict(
# TODO: remove when deprecating Pydantic v1
{"$ref": "#/components/schemas/TeamRead"}
{"$ref": "#/components/schemas/TeamPublic"}
),
},
},
@ -681,8 +681,8 @@ def test_tutorial(clear_sqlmodel):
"headquarters": {"title": "Headquarters", "type": "string"},
},
},
"TeamRead": {
"title": "TeamRead",
"TeamPublic": {
"title": "TeamPublic",
"required": ["name", "headquarters", "id"],
"type": "object",
"properties": {
@ -691,8 +691,8 @@ def test_tutorial(clear_sqlmodel):
"id": {"title": "Id", "type": "integer"},
},
},
"TeamReadWithHeroes": {
"title": "TeamReadWithHeroes",
"TeamPublicWithHeroes": {
"title": "TeamPublicWithHeroes",
"required": ["name", "headquarters", "id"],
"type": "object",
"properties": {
@ -702,7 +702,7 @@ def test_tutorial(clear_sqlmodel):
"heroes": {
"title": "Heroes",
"type": "array",
"items": {"$ref": "#/components/schemas/HeroRead"},
"items": {"$ref": "#/components/schemas/HeroPublic"},
"default": [],
},
},

View File

@ -150,7 +150,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -187,7 +187,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -223,7 +223,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroReadWithTeam"
"$ref": "#/components/schemas/HeroPublicWithTeam"
}
}
},
@ -295,7 +295,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -349,7 +349,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Teams Teams Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
},
}
}
@ -386,7 +386,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
}
}
},
@ -422,7 +422,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamReadWithHeroes"
"$ref": "#/components/schemas/TeamPublicWithHeroes"
}
}
},
@ -494,7 +494,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
}
}
},
@ -557,8 +557,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {
@ -587,8 +587,8 @@ def test_tutorial(clear_sqlmodel):
"id": {"title": "Id", "type": "integer"},
},
},
"HeroReadWithTeam": {
"title": "HeroReadWithTeam",
"HeroPublicWithTeam": {
"title": "HeroPublicWithTeam",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {
@ -618,14 +618,14 @@ def test_tutorial(clear_sqlmodel):
"team": IsDict(
{
"anyOf": [
{"$ref": "#/components/schemas/TeamRead"},
{"$ref": "#/components/schemas/TeamPublic"},
{"type": "null"},
]
}
)
| IsDict(
# TODO: remove when deprecating Pydantic v1
{"$ref": "#/components/schemas/TeamRead"}
{"$ref": "#/components/schemas/TeamPublic"}
),
},
},
@ -684,8 +684,8 @@ def test_tutorial(clear_sqlmodel):
"headquarters": {"title": "Headquarters", "type": "string"},
},
},
"TeamRead": {
"title": "TeamRead",
"TeamPublic": {
"title": "TeamPublic",
"required": ["name", "headquarters", "id"],
"type": "object",
"properties": {
@ -694,8 +694,8 @@ def test_tutorial(clear_sqlmodel):
"id": {"title": "Id", "type": "integer"},
},
},
"TeamReadWithHeroes": {
"title": "TeamReadWithHeroes",
"TeamPublicWithHeroes": {
"title": "TeamPublicWithHeroes",
"required": ["name", "headquarters", "id"],
"type": "object",
"properties": {
@ -705,7 +705,7 @@ def test_tutorial(clear_sqlmodel):
"heroes": {
"title": "Heroes",
"type": "array",
"items": {"$ref": "#/components/schemas/HeroRead"},
"items": {"$ref": "#/components/schemas/HeroPublic"},
"default": [],
},
},

View File

@ -150,7 +150,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -187,7 +187,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -223,7 +223,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroReadWithTeam"
"$ref": "#/components/schemas/HeroPublicWithTeam"
}
}
},
@ -295,7 +295,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -349,7 +349,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Teams Teams Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
},
}
}
@ -386,7 +386,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
}
}
},
@ -422,7 +422,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamReadWithHeroes"
"$ref": "#/components/schemas/TeamPublicWithHeroes"
}
}
},
@ -494,7 +494,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
}
}
},
@ -557,8 +557,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {
@ -587,8 +587,8 @@ def test_tutorial(clear_sqlmodel):
"id": {"title": "Id", "type": "integer"},
},
},
"HeroReadWithTeam": {
"title": "HeroReadWithTeam",
"HeroPublicWithTeam": {
"title": "HeroPublicWithTeam",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {
@ -618,14 +618,14 @@ def test_tutorial(clear_sqlmodel):
"team": IsDict(
{
"anyOf": [
{"$ref": "#/components/schemas/TeamRead"},
{"$ref": "#/components/schemas/TeamPublic"},
{"type": "null"},
]
}
)
| IsDict(
# TODO: remove when deprecating Pydantic v1
{"$ref": "#/components/schemas/TeamRead"}
{"$ref": "#/components/schemas/TeamPublic"}
),
},
},
@ -684,8 +684,8 @@ def test_tutorial(clear_sqlmodel):
"headquarters": {"title": "Headquarters", "type": "string"},
},
},
"TeamRead": {
"title": "TeamRead",
"TeamPublic": {
"title": "TeamPublic",
"required": ["name", "headquarters", "id"],
"type": "object",
"properties": {
@ -694,8 +694,8 @@ def test_tutorial(clear_sqlmodel):
"id": {"title": "Id", "type": "integer"},
},
},
"TeamReadWithHeroes": {
"title": "TeamReadWithHeroes",
"TeamPublicWithHeroes": {
"title": "TeamPublicWithHeroes",
"required": ["name", "headquarters", "id"],
"type": "object",
"properties": {
@ -705,7 +705,7 @@ def test_tutorial(clear_sqlmodel):
"heroes": {
"title": "Heroes",
"type": "array",
"items": {"$ref": "#/components/schemas/HeroRead"},
"items": {"$ref": "#/components/schemas/HeroPublic"},
"default": [],
},
},

View File

@ -99,7 +99,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -136,7 +136,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -172,7 +172,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -244,7 +244,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -297,8 +297,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -104,7 +104,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -141,7 +141,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -177,7 +177,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -249,7 +249,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -302,8 +302,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -104,7 +104,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -141,7 +141,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -177,7 +177,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -249,7 +249,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -302,8 +302,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -134,7 +134,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -171,7 +171,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -207,7 +207,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -279,7 +279,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -333,7 +333,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Teams Teams Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
},
}
}
@ -370,7 +370,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
}
}
},
@ -406,7 +406,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
}
}
},
@ -478,7 +478,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
}
}
},
@ -541,8 +541,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {
@ -626,8 +626,8 @@ def test_tutorial(clear_sqlmodel):
"headquarters": {"title": "Headquarters", "type": "string"},
},
},
"TeamRead": {
"title": "TeamRead",
"TeamPublic": {
"title": "TeamPublic",
"required": ["name", "headquarters", "id"],
"type": "object",
"properties": {

View File

@ -137,7 +137,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -174,7 +174,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -210,7 +210,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -282,7 +282,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -336,7 +336,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Teams Teams Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
},
}
}
@ -373,7 +373,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
}
}
},
@ -409,7 +409,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
}
}
},
@ -481,7 +481,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
}
}
},
@ -544,8 +544,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {
@ -629,8 +629,8 @@ def test_tutorial(clear_sqlmodel):
"headquarters": {"title": "Headquarters", "type": "string"},
},
},
"TeamRead": {
"title": "TeamRead",
"TeamPublic": {
"title": "TeamPublic",
"required": ["name", "headquarters", "id"],
"type": "object",
"properties": {

View File

@ -137,7 +137,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -174,7 +174,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -210,7 +210,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -282,7 +282,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -336,7 +336,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Teams Teams Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
},
}
}
@ -373,7 +373,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
}
}
},
@ -409,7 +409,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
}
}
},
@ -481,7 +481,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamRead"
"$ref": "#/components/schemas/TeamPublic"
}
}
},
@ -544,8 +544,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {
@ -629,8 +629,8 @@ def test_tutorial(clear_sqlmodel):
"headquarters": {"title": "Headquarters", "type": "string"},
},
},
"TeamRead": {
"title": "TeamRead",
"TeamPublic": {
"title": "TeamPublic",
"required": ["name", "headquarters", "id"],
"type": "object",
"properties": {

View File

@ -106,7 +106,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -143,7 +143,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -179,7 +179,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -223,7 +223,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -276,8 +276,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -109,7 +109,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -146,7 +146,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -182,7 +182,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -226,7 +226,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -279,8 +279,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -109,7 +109,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -146,7 +146,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -182,7 +182,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -226,7 +226,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -279,8 +279,8 @@ def test_tutorial(clear_sqlmodel):
),
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -169,7 +169,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -206,7 +206,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -242,7 +242,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -286,7 +286,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -340,8 +340,8 @@ def test_tutorial(clear_sqlmodel):
"password": {"type": "string", "title": "Password"},
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -172,7 +172,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -209,7 +209,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -245,7 +245,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -289,7 +289,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -343,8 +343,8 @@ def test_tutorial(clear_sqlmodel):
"password": {"type": "string", "title": "Password"},
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {

View File

@ -172,7 +172,7 @@ def test_tutorial(clear_sqlmodel):
"title": "Response Read Heroes Heroes Get",
"type": "array",
"items": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
},
}
}
@ -209,7 +209,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -245,7 +245,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -289,7 +289,7 @@ def test_tutorial(clear_sqlmodel):
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HeroRead"
"$ref": "#/components/schemas/HeroPublic"
}
}
},
@ -343,8 +343,8 @@ def test_tutorial(clear_sqlmodel):
"password": {"type": "string", "title": "Password"},
},
},
"HeroRead": {
"title": "HeroRead",
"HeroPublic": {
"title": "HeroPublic",
"required": ["name", "secret_name", "id"],
"type": "object",
"properties": {