From d192142eb9e83d52c3cb5bd7d5bcba93d40cb41c Mon Sep 17 00:00:00 2001 From: Jerry Wu Date: Tue, 24 Oct 2023 00:28:51 +0800 Subject: [PATCH] =?utf8?q?=F0=9F=93=9D=20Fix=20docs=20for=20Pydantic's=20f?= =?utf8?q?ields=20using=20`le`=20(`lte`=20is=20invalid,=20use=20`le`=20)?= =?utf8?q?=20(#207)?= MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Co-authored-by: Sebastián Ramírez --- docs/tutorial/fastapi/limit-and-offset.md | 2 +- docs_src/tutorial/fastapi/app_testing/tutorial001/main.py | 2 +- docs_src/tutorial/fastapi/delete/tutorial001.py | 2 +- docs_src/tutorial/fastapi/limit_and_offset/tutorial001.py | 2 +- docs_src/tutorial/fastapi/relationships/tutorial001.py | 4 ++-- .../fastapi/session_with_dependency/tutorial001.py | 2 +- docs_src/tutorial/fastapi/teams/tutorial001.py | 4 ++-- docs_src/tutorial/fastapi/update/tutorial001.py | 2 +- .../test_fastapi/test_delete/test_tutorial001.py | 5 ++--- .../test_fastapi/test_limit_and_offset/test_tutorial001.py | 5 ++--- .../test_fastapi/test_relationships/test_tutorial001.py | 7 +++---- .../test_session_with_dependency/test_tutorial001.py | 5 ++--- .../test_fastapi/test_teams/test_tutorial001.py | 7 +++---- .../test_fastapi/test_update/test_tutorial001.py | 5 ++--- 14 files changed, 24 insertions(+), 30 deletions(-) diff --git a/docs/tutorial/fastapi/limit-and-offset.md b/docs/tutorial/fastapi/limit-and-offset.md index 92bbfc7e..8802f4ec 100644 --- a/docs/tutorial/fastapi/limit-and-offset.md +++ b/docs/tutorial/fastapi/limit-and-offset.md @@ -42,7 +42,7 @@ We want to allow clients to set different `offset` and `limit` values. But we don't want them to be able to set a `limit` of something like `9999`, that's over `9000`! 😱 -So, to prevent it, we add additional validation to the `limit` query parameter, declaring that it has to be **l**ess **t**han or **e**qual to `100` with `lte=100`. +So, to prevent it, we add additional validation to the `limit` query parameter, declaring that it has to be **l**ess than or **e**qual to `100` with `le=100`. This way, a client can decide to take fewer heroes if they want, but not more. diff --git a/docs_src/tutorial/fastapi/app_testing/tutorial001/main.py b/docs_src/tutorial/fastapi/app_testing/tutorial001/main.py index d106c4eb..3f0602e4 100644 --- a/docs_src/tutorial/fastapi/app_testing/tutorial001/main.py +++ b/docs_src/tutorial/fastapi/app_testing/tutorial001/main.py @@ -66,7 +66,7 @@ def read_heroes( *, session: Session = Depends(get_session), offset: int = 0, - limit: int = Query(default=100, lte=100), + limit: int = Query(default=100, le=100), ): heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() return heroes diff --git a/docs_src/tutorial/fastapi/delete/tutorial001.py b/docs_src/tutorial/fastapi/delete/tutorial001.py index 3c15efbb..3069fc5e 100644 --- a/docs_src/tutorial/fastapi/delete/tutorial001.py +++ b/docs_src/tutorial/fastapi/delete/tutorial001.py @@ -58,7 +58,7 @@ def create_hero(hero: HeroCreate): @app.get("/heroes/", response_model=List[HeroRead]) -def read_heroes(offset: int = 0, limit: int = Query(default=100, lte=100)): +def read_heroes(offset: int = 0, limit: int = Query(default=100, le=100)): with Session(engine) as session: heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() return heroes diff --git a/docs_src/tutorial/fastapi/limit_and_offset/tutorial001.py b/docs_src/tutorial/fastapi/limit_and_offset/tutorial001.py index aef21332..2b8739ca 100644 --- a/docs_src/tutorial/fastapi/limit_and_offset/tutorial001.py +++ b/docs_src/tutorial/fastapi/limit_and_offset/tutorial001.py @@ -52,7 +52,7 @@ def create_hero(hero: HeroCreate): @app.get("/heroes/", response_model=List[HeroRead]) -def read_heroes(offset: int = 0, limit: int = Query(default=100, lte=100)): +def read_heroes(offset: int = 0, limit: int = Query(default=100, le=100)): with Session(engine) as session: heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() return heroes diff --git a/docs_src/tutorial/fastapi/relationships/tutorial001.py b/docs_src/tutorial/fastapi/relationships/tutorial001.py index 6a038466..8477e4a2 100644 --- a/docs_src/tutorial/fastapi/relationships/tutorial001.py +++ b/docs_src/tutorial/fastapi/relationships/tutorial001.py @@ -104,7 +104,7 @@ def read_heroes( *, session: Session = Depends(get_session), offset: int = 0, - limit: int = Query(default=100, lte=100), + limit: int = Query(default=100, le=100), ): heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() return heroes @@ -158,7 +158,7 @@ def read_teams( *, session: Session = Depends(get_session), offset: int = 0, - limit: int = Query(default=100, lte=100), + limit: int = Query(default=100, le=100), ): teams = session.exec(select(Team).offset(offset).limit(limit)).all() return teams diff --git a/docs_src/tutorial/fastapi/session_with_dependency/tutorial001.py b/docs_src/tutorial/fastapi/session_with_dependency/tutorial001.py index d106c4eb..3f0602e4 100644 --- a/docs_src/tutorial/fastapi/session_with_dependency/tutorial001.py +++ b/docs_src/tutorial/fastapi/session_with_dependency/tutorial001.py @@ -66,7 +66,7 @@ def read_heroes( *, session: Session = Depends(get_session), offset: int = 0, - limit: int = Query(default=100, lte=100), + limit: int = Query(default=100, le=100), ): heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() return heroes diff --git a/docs_src/tutorial/fastapi/teams/tutorial001.py b/docs_src/tutorial/fastapi/teams/tutorial001.py index 6f84182b..1da0dad8 100644 --- a/docs_src/tutorial/fastapi/teams/tutorial001.py +++ b/docs_src/tutorial/fastapi/teams/tutorial001.py @@ -95,7 +95,7 @@ def read_heroes( *, session: Session = Depends(get_session), offset: int = 0, - limit: int = Query(default=100, lte=100), + limit: int = Query(default=100, le=100), ): heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() return heroes @@ -149,7 +149,7 @@ def read_teams( *, session: Session = Depends(get_session), offset: int = 0, - limit: int = Query(default=100, lte=100), + limit: int = Query(default=100, le=100), ): teams = session.exec(select(Team).offset(offset).limit(limit)).all() return teams diff --git a/docs_src/tutorial/fastapi/update/tutorial001.py b/docs_src/tutorial/fastapi/update/tutorial001.py index 35554878..bb98efd5 100644 --- a/docs_src/tutorial/fastapi/update/tutorial001.py +++ b/docs_src/tutorial/fastapi/update/tutorial001.py @@ -58,7 +58,7 @@ def create_hero(hero: HeroCreate): @app.get("/heroes/", response_model=List[HeroRead]) -def read_heroes(offset: int = 0, limit: int = Query(default=100, lte=100)): +def read_heroes(offset: int = 0, limit: int = Query(default=100, le=100)): with Session(engine) as session: heroes = session.exec(select(Hero).offset(offset).limit(limit)).all() return heroes diff --git a/tests/test_tutorial/test_fastapi/test_delete/test_tutorial001.py b/tests/test_tutorial/test_fastapi/test_delete/test_tutorial001.py index 8979245d..b08affb9 100644 --- a/tests/test_tutorial/test_fastapi/test_delete/test_tutorial001.py +++ b/tests/test_tutorial/test_fastapi/test_delete/test_tutorial001.py @@ -57,9 +57,8 @@ def test_tutorial(clear_sqlmodel): assert response.status_code == 404, response.text response = client.get("/openapi.json") - data = response.json() assert response.status_code == 200, response.text - assert data == { + assert response.json() == { "openapi": "3.0.2", "info": {"title": "FastAPI", "version": "0.1.0"}, "paths": { @@ -82,9 +81,9 @@ def test_tutorial(clear_sqlmodel): "required": False, "schema": { "title": "Limit", + "maximum": 100.0, "type": "integer", "default": 100, - "lte": 100, }, "name": "limit", "in": "query", diff --git a/tests/test_tutorial/test_fastapi/test_limit_and_offset/test_tutorial001.py b/tests/test_tutorial/test_fastapi/test_limit_and_offset/test_tutorial001.py index d7f642a7..0aee3ca0 100644 --- a/tests/test_tutorial/test_fastapi/test_limit_and_offset/test_tutorial001.py +++ b/tests/test_tutorial/test_fastapi/test_limit_and_offset/test_tutorial001.py @@ -62,9 +62,8 @@ def test_tutorial(clear_sqlmodel): assert data[0]["name"] == hero2_data["name"] response = client.get("/openapi.json") - data = response.json() assert response.status_code == 200, response.text - assert data == { + assert response.json() == { "openapi": "3.0.2", "info": {"title": "FastAPI", "version": "0.1.0"}, "paths": { @@ -87,9 +86,9 @@ def test_tutorial(clear_sqlmodel): "required": False, "schema": { "title": "Limit", + "maximum": 100.0, "type": "integer", "default": 100, - "lte": 100, }, "name": "limit", "in": "query", diff --git a/tests/test_tutorial/test_fastapi/test_relationships/test_tutorial001.py b/tests/test_tutorial/test_fastapi/test_relationships/test_tutorial001.py index 2ea5e8d6..8869862e 100644 --- a/tests/test_tutorial/test_fastapi/test_relationships/test_tutorial001.py +++ b/tests/test_tutorial/test_fastapi/test_relationships/test_tutorial001.py @@ -105,9 +105,8 @@ def test_tutorial(clear_sqlmodel): assert len(data) == 1 response = client.get("/openapi.json") - data = response.json() assert response.status_code == 200, response.text - assert data == { + assert response.json() == { "openapi": "3.0.2", "info": {"title": "FastAPI", "version": "0.1.0"}, "paths": { @@ -130,9 +129,9 @@ def test_tutorial(clear_sqlmodel): "required": False, "schema": { "title": "Limit", + "maximum": 100.0, "type": "integer", "default": 100, - "lte": 100, }, "name": "limit", "in": "query", @@ -329,9 +328,9 @@ def test_tutorial(clear_sqlmodel): "required": False, "schema": { "title": "Limit", + "maximum": 100.0, "type": "integer", "default": 100, - "lte": 100, }, "name": "limit", "in": "query", diff --git a/tests/test_tutorial/test_fastapi/test_session_with_dependency/test_tutorial001.py b/tests/test_tutorial/test_fastapi/test_session_with_dependency/test_tutorial001.py index da87b8e5..cb0a6f92 100644 --- a/tests/test_tutorial/test_fastapi/test_session_with_dependency/test_tutorial001.py +++ b/tests/test_tutorial/test_fastapi/test_session_with_dependency/test_tutorial001.py @@ -57,9 +57,8 @@ def test_tutorial(clear_sqlmodel): assert response.status_code == 404, response.text response = client.get("/openapi.json") - data = response.json() assert response.status_code == 200, response.text - assert data == { + assert response.json() == { "openapi": "3.0.2", "info": {"title": "FastAPI", "version": "0.1.0"}, "paths": { @@ -82,9 +81,9 @@ def test_tutorial(clear_sqlmodel): "required": False, "schema": { "title": "Limit", + "maximum": 100.0, "type": "integer", "default": 100, - "lte": 100, }, "name": "limit", "in": "query", diff --git a/tests/test_tutorial/test_fastapi/test_teams/test_tutorial001.py b/tests/test_tutorial/test_fastapi/test_teams/test_tutorial001.py index 08be835a..e66c9751 100644 --- a/tests/test_tutorial/test_fastapi/test_teams/test_tutorial001.py +++ b/tests/test_tutorial/test_fastapi/test_teams/test_tutorial001.py @@ -92,9 +92,8 @@ def test_tutorial(clear_sqlmodel): assert len(data) == 1 response = client.get("/openapi.json") - data = response.json() assert response.status_code == 200, response.text - assert data == { + assert response.json() == { "openapi": "3.0.2", "info": {"title": "FastAPI", "version": "0.1.0"}, "paths": { @@ -117,9 +116,9 @@ def test_tutorial(clear_sqlmodel): "required": False, "schema": { "title": "Limit", + "maximum": 100.0, "type": "integer", "default": 100, - "lte": 100, }, "name": "limit", "in": "query", @@ -316,9 +315,9 @@ def test_tutorial(clear_sqlmodel): "required": False, "schema": { "title": "Limit", + "maximum": 100.0, "type": "integer", "default": 100, - "lte": 100, }, "name": "limit", "in": "query", diff --git a/tests/test_tutorial/test_fastapi/test_update/test_tutorial001.py b/tests/test_tutorial/test_fastapi/test_update/test_tutorial001.py index 7f487801..49906256 100644 --- a/tests/test_tutorial/test_fastapi/test_update/test_tutorial001.py +++ b/tests/test_tutorial/test_fastapi/test_update/test_tutorial001.py @@ -64,9 +64,8 @@ def test_tutorial(clear_sqlmodel): assert response.status_code == 404, response.text response = client.get("/openapi.json") - data = response.json() assert response.status_code == 200, response.text - assert data == { + assert response.json() == { "openapi": "3.0.2", "info": {"title": "FastAPI", "version": "0.1.0"}, "paths": { @@ -89,9 +88,9 @@ def test_tutorial(clear_sqlmodel): "required": False, "schema": { "title": "Limit", + "maximum": 100.0, "type": "integer", "default": 100, - "lte": 100, }, "name": "limit", "in": "query", -- 2.47.2