`src.ska_src_api_accounting.models.response`

API response classes.

Module Contents

Classes

`GenericErrorResponse`	The generic error response model.
`GenericOperationResponse`	The generic operation error response model.
`HealthResponse`	The health endpoint response model.
`NodeResourceResponse`	The node resource response model.
`NodesListResponse`	The nodes list response model.
`PingResponse`	The ping endpoint response model.
`Response`	The base response model.

class src.ska_src_api_accounting.models.response.GenericErrorResponse

Bases: Response

The generic error response model.

detail: str

class src.ska_src_api_accounting.models.response.GenericOperationResponse

Bases: Response

The generic operation error response model.

successful: bool

class src.ska_src_api_accounting.models.response.HealthResponse

Bases: Response

The health endpoint response model.

class DependentServices

Bases: pydantic.BaseModel

The dependent services response model.

class DependentServiceStatus

Bases: pydantic.BaseModel

The dependent services state response model.

status: Literal[UP, DOWN]

permissions_api: HealthResponse.DependentServices.DependentServiceStatus

dependent_services: HealthResponse.DependentServices

number_of_managed_requests: pydantic.NonNegativeInt

uptime: pydantic.NonNegativeInt

class src.ska_src_api_accounting.models.response.NodeResourceResponse

Bases: Response

The node resource response model.

compute: ska_src_api_accounting.models.compute.Compute

node_name: str

storage: ska_src_api_accounting.models.storage.Storage

class src.ska_src_api_accounting.models.response.NodesListResponse

Bases: Response

The nodes list response model.

nodes: list[ska_src_api_accounting.models.nodes.Node]

class src.ska_src_api_accounting.models.response.PingResponse

Bases: Response

The ping endpoint response model.

status: Literal[UP, DOWN]

version: str

class src.ska_src_api_accounting.models.response.Response

Bases: pydantic.BaseModel

The base response model.