Skip to content

responses

Pydantic models/schemas for the API responses.

DatabasesResponse (EntryResponseMany) pydantic-model

Successful response for GET /databases

This model is essentially equal to LinksResponse with the exception of the `data´ field's description.

DatabasesResponseSingle (EntryResponseOne) pydantic-model

Successful response for POST /databases and GET /databases/{database_id}

GatewaysResponse (EntryResponseMany) pydantic-model

Successful response for GET /gateways

GatewaysResponseSingle (EntryResponseOne) pydantic-model

Successful response for POST /gateways and GET /gateways/{gateway_id}.

QueriesResponse (EntryResponseMany) pydantic-model

Successful response for GET /gateways/{gateway_ID}/queries.

QueriesResponseSingle (EntryResponseOne) pydantic-model

Successful response for POST /gateways/{gateway_ID}/queries and GET /gateways/{gateway_ID}/queries/{query_id}.

Back to top