ska_src_api_global_execution.models.response

API response classes.

Module Contents

Classes

ExecutionSubmissionResponse	The job submission response model.
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.
Response	The base response model.

class ska_src_api_global_execution.models.response.ExecutionSubmissionResponse(/, **data)

Bases: Response

digraph inheritanceb127d97ba3 { 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\""]; "ExecutionSubmissionResponse" [URL="#ska_src_api_global_execution.models.response.ExecutionSubmissionResponse",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 job submission response model."]; "Response" -> "ExecutionSubmissionResponse" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Response" [URL="#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 job submission response model.

additional_info: dict | None

id: str | None

response_code: Annotated[int, Field(ge=0, description='Response code; see README', json_schema_extra={'examples': [2]})]

response_text: str

class ska_src_api_global_execution.models.response.GenericErrorResponse(/, **data)

Bases: Response

digraph inheritance3030bfbfea { 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="#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="#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.response.GenericOperationResponse(/, **data)

Bases: Response

digraph inheritance0cb40e4f22 { 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="#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="#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.response.HealthResponse(/, **data)

Bases: Response

digraph inheritancee99b2efde8 { 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="#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="#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 inheritance8beceb3616 { 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="#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 inheritance34dfde36be { 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="#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.response.PingResponse(/, **data)

Bases: Response

digraph inheritancef534604d65 { 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="#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="#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

class ska_src_api_global_execution.models.response.Response(/, **data)

Bases: pydantic.BaseModel

digraph inheritance775e532440 { 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\""]; "Response" [URL="#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 base response model.