ska_src_api_global_execution.models

Response models import.

Submodules

Package Contents

Classes

GenericErrorResponse

The generic error response model.

GenericOperationResponse

The generic operation error response model.

HealthResponse

The health endpoint response model.

PingResponse

The ping endpoint response model.
class ska_src_api_global_execution.models.GenericErrorResponse(/, **data)

Bases: Response

digraph inheritancebd52af7d4c { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseModel" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="!!! abstract \"Usage Documentation\""]; "GenericErrorResponse" [URL="response/index.html#ska_src_api_global_execution.models.response.GenericErrorResponse",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The generic error response model."]; "Response" -> "GenericErrorResponse" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Response" [URL="response/index.html#ska_src_api_global_execution.models.response.Response",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The base response model."]; "BaseModel" -> "Response" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

The generic error response model.

detail: str
class ska_src_api_global_execution.models.GenericOperationResponse(/, **data)

Bases: Response

digraph inheritance6984ad40ec { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseModel" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="!!! abstract \"Usage Documentation\""]; "GenericOperationResponse" [URL="response/index.html#ska_src_api_global_execution.models.response.GenericOperationResponse",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The generic operation error response model."]; "Response" -> "GenericOperationResponse" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Response" [URL="response/index.html#ska_src_api_global_execution.models.response.Response",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The base response model."]; "BaseModel" -> "Response" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

The generic operation error response model.

successful: bool
class ska_src_api_global_execution.models.HealthResponse(/, **data)

Bases: Response

digraph inheritancea988a125b6 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseModel" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="!!! abstract \"Usage Documentation\""]; "HealthResponse" [URL="response/index.html#ska_src_api_global_execution.models.response.HealthResponse",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The health endpoint response model."]; "Response" -> "HealthResponse" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Response" [URL="response/index.html#ska_src_api_global_execution.models.response.Response",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The base response model."]; "BaseModel" -> "Response" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

The health endpoint response model.

class DependentServices(/, **data)

Bases: pydantic.BaseModel

digraph inheritance12c4bc59ee { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseModel" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="!!! abstract \"Usage Documentation\""]; "DependentServices" [URL="response/index.html#ska_src_api_global_execution.models.response.HealthResponse.DependentServices",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The dependent services response model."]; "BaseModel" -> "DependentServices" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

The dependent services response model.

class DependentServiceStatus(/, **data)

Bases: pydantic.BaseModel

digraph inheritanceb4ecd62e58 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseModel" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="!!! abstract \"Usage Documentation\""]; "DependentServiceStatus" [URL="response/index.html#ska_src_api_global_execution.models.response.HealthResponse.DependentServices.DependentServiceStatus",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The dependent services state response model."]; "BaseModel" -> "DependentServiceStatus" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

The dependent services state response model.

status: Literal[UP, DOWN]
permissions_api: HealthResponse.DependentServices.DependentServiceStatus
dependent_services: HealthResponse.DependentServices
number_of_managed_requests: Annotated[int, Field(ge=0, json_schema_extra={'examples': [50]})]
uptime: Annotated[int, Field(ge=0, json_schema_extra={'examples': [1000]})]
class ska_src_api_global_execution.models.PingResponse(/, **data)

Bases: Response

digraph inheritancefeeb2bf798 { bgcolor=transparent; rankdir=LR; size="8.0, 12.0"; "BaseModel" [fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",tooltip="!!! abstract \"Usage Documentation\""]; "PingResponse" [URL="response/index.html#ska_src_api_global_execution.models.response.PingResponse",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The ping endpoint response model."]; "Response" -> "PingResponse" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Response" [URL="response/index.html#ska_src_api_global_execution.models.response.Response",fillcolor=white,fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",fontsize=10,height=0.25,shape=box,style="setlinewidth(0.5),filled",target="_top",tooltip="The base response model."]; "BaseModel" -> "Response" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

The ping endpoint response model.

status: Literal[UP, DOWN]
version: str