docs(swagger): exclude basic routes from swagger

quack-ai · Mar 28, 2024 · 89143d9 · 89143d9
1 parent b4e35ce
commit 89143d9
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 3 deletions.
diff --git a/src/app/api/api_v1/endpoints/login.py b/src/app/api/api_v1/endpoints/login.py
@@ -24,7 +24,7 @@
 router = APIRouter()
 
 
-@router.get("/authorize", summary="Request authorization code through GitHub OAuth app")
+@router.get("/authorize", summary="Request authorization code through GitHub OAuth app", include_in_schema=False)
 async def authorize_github(
     scope: str,
     redirect_uri: HttpUrl,
@@ -34,7 +34,12 @@ async def authorize_github(
     )
 
 
-@router.post("/github", status_code=status.HTTP_200_OK, summary="Request a GitHub token from authorization code")
+@router.post(
+    "/github",
+    status_code=status.HTTP_200_OK,
+    summary="Request a GitHub token from authorization code",
+    include_in_schema=False,
+)
 async def request_github_token_from_code(
     payload: TokenRequest,
 ) -> GHToken:

diff --git a/src/app/main.py b/src/app/main.py
@@ -57,7 +57,7 @@ async def startup() -> None:
 
 
 # Healthcheck
-@app.get("/status", status_code=status.HTTP_200_OK, summary="Healthcheck for the API")
+@app.get("/status", status_code=status.HTTP_200_OK, summary="Healthcheck for the API", include_in_schema=False)
 def get_status() -> Status:
     return Status(status="ok")