kedro.server.models¶
kedro.server.models ¶
Pydantic models for Kedro server request/response schemas.
| Name | Type | Description |
|---|---|---|
RunRequest |
Class | Request model for pipeline execution via POST /run. |
RunResponse |
Class | Response model returned by POST /run. |
ErrorDetail |
Class | Structured error information included in a failed RunResponse. |
HealthResponse |
Class | Response model returned by GET /health. |
SnapshotResponse |
Class | Response model returned by GET /snapshot. |
kedro.server.models.RunRequest ¶
Bases: BaseModel
Request model for pipeline execution.
This model captures the parameters that can be sent in a request to the /run endpoint of the Kedro HTTP server.
Unlike the kedro run CLI command, conf_source and env are not included in this request model, as they are
expected to be set at the server level (e.g. via environment variables or server configuration) rather than per request.
kedro.server.models.RunResponse
module-attribute
¶
RunResponse = Annotated[RunSuccess | RunFailure, Field(discriminator='status')]
kedro.server.models.ErrorDetail ¶
Bases: BaseModel
Structured error information.
kedro.server.models.HealthResponse ¶
Bases: BaseModel
Response model for health check endpoint.
kedro.server.models.SnapshotResponse
module-attribute
¶
SnapshotResponse = Annotated[SnapshotSuccess | SnapshotFailure, Field(discriminator='status')]