src.api.entrypoints.v1.routes.routes module

src.api.entrypoints.v1.routes.routes.health()[source]

Check the health of the application. — tags:

System

summary: Check the health of the API description: Checks if the application can connect to the IAU CPS URL and is healthy responses:

200:
description: API is healthy and can connect to required services content:

application/json:

schema:
type: object properties:

message:
type: string example: Healthy

503:
description: API is not healthy due to connection issues content:

application/json:

schema:
type: object properties:

error:
type: string example: Error unable to connect to IAU CPS URL

src.api.entrypoints.v1.routes.routes.page_not_found(error)[source]

Handle page not found errors. — tags:

Errors

summary: Page not found error description: Returns when a requested page or endpoint doesn’t exist responses:

404:
description: The requested page or endpoint was not found

src.api.entrypoints.v1.routes.routes.ratelimit_handler(e)[source]

Handle rate limit errors. — tags:

Errors

summary: Rate limit error description: Returns when API request rate limits are exceeded responses:

429:
description: The client has exceeded the allowed request rate

src.api.entrypoints.v1.routes.routes.root()[source]

Redirect to API documentation. — tags:

System

summary: API root endpoint description: Redirects to the API documentation page responses:

302:
description: Redirects to the API documentation URL