GitHub-Proxy/sqlmodel-fix
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files

38
tests/test_tutorial/test_fastapi/test_relationships/test_tutorial001.py
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": [],
},
},

38
tests/test_tutorial/test_fastapi/test_relationships/test_tutorial001_py310.py
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": [],
},
},

38
tests/test_tutorial/test_fastapi/test_relationships/test_tutorial001_py39.py
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": [],
},
},