Expand description
API entities — DTOs and query parameter types.
These types form the public API contract. They map from internal store models and are never exposed directly.
Re-exports§
pub use lease::DEFAULT_LEASE_TTL_SECS;pub use lease::MAX_LEASE_TTL_SECS;pub use lease::RenewLeaseRequest;pub use lease::RenewLeaseResponse;pub use lease::validate_lease_ttl;
Modules§
- lease
- Worker lease request/response types for the internal routes.
Structs§
- Account
Form Field Response - A form field of an account kind.
- Account
Kind Response - A supported account kind.
- Account
Usage Point Response - One historical observation of a window.
- Account
Window Response - One usage window of an account.
- Approval
Delegation Response - Approval delegation response.
- Artifact
Response - An artifact as exposed by the REST API.
- Cancel
RunResponse - Response of
POST /api/v1/runs/:id/cancel: the cancelled run, with the sub-workflow runs cancelled along with it. - Change
Password Request - Change password request body.
- Create
Approval Delegation Request - Create delegation request body.
- Create
Provider Account Request - Request body to add a Provider Account. Admin only.
- Create
RunRequest - Request to trigger a workflow.
- Create
Schedule Request - Create schedule request body.
- Create
User Request - Request body for creating a user (admin only).
- Created
By - The author of a run, as exposed by the API.
- KeyVersions
Response - How the configured key ring lines up with the stored secrets.
- List
Approval Delegations Query - Query parameters for listing delegations.
- List
Provider Accounts Query - Query of
GET /provider-accounts. - List
Runs Query - Query parameters for listing runs.
- List
Signals Query - Query parameters for listing signals.
- MeResponse
- Current user profile response.
- Pause
RunResponse - Response of
POST /api/v1/runs/:id/pause: the paused run, with the sub-workflow runs paused along with it. - Provider
Account Response - A Provider Account, without its credential.
- Provider
Account Test Response - Response of
POST /provider-accounts/{id}/test. - Provider
Account Usage Response - Current windows and history of an account.
- Rejected
RunResponse - A waiting run whose payload schema the signal did not match.
- Resume
RunResponse - Response of
POST /api/v1/runs/:id/resume: the resumed run, with the sub-workflow runs resumed along with it. - Resumed
RunResponse - A run resumed by a signal.
- Rotate
Secrets Request - Request body for rotating a batch of secrets to another key version.
- Rotate
Secrets Response - Outcome of one rotation batch.
- RunDetail
Response - Run detail response — includes steps and payload.
- RunResponse
- Run response DTO — public API representation of a run.
- Schedule
Response - Schedule list/detail response.
- Secret
Response - Response DTO for a secret (never exposes the value).
- Send
Signal Request - Send signal request body.
- SetSecret
Request - Request body for creating or updating a secret.
- Sign
InRequest - Sign-in request body.
- Sign
UpRequest - Sign-up request body.
- Signal
Delivery Response - Result of sending a signal.
- Signal
Response - A stored signal.
- Stats
History Bucket Response - One time bucket in the history response.
- Stats
History Query - Query parameters for
GET /api/v1/stats/history. - Stats
History Response - Time-bucketed historical statistics response.
- Stats
Response - Aggregate statistics response.
- Step
Account Response - Readable identity of the Provider Account a step ran under.
- Step
Response - Step response DTO — public API representation of a step.
- Update
Provider Account Request - Request body to update a Provider Account. All fields optional;
nameandkindare immutable. - Update
Role Request - Request body for updating a user’s role (admin only).
- Update
Schedule Request - Update schedule request body. All fields optional.
- Update
User Groups Request - Request body for replacing a user’s group memberships (admin only).
- Usage
Query - Query of
GET /provider-accounts/{id}/usage. - User
Groups Response - Response DTO for a user’s group memberships.
- User
Response - Response DTO for a user (never exposes password hash).
- Worker
Routing - Workers the API saw recently, as seen from one queued run.
- Workflow
Pause Response - Response of
POST /api/v1/workflows/:name/pauseandPOST /api/v1/workflows/:name/resume.
Enums§
- Account
State - Derived state of an account, for display.
- Account
Test Result - Outcome of a live credential test.
- Created
ByKind - What kind of principal triggered a run.
- Idempotency
KeyError - Why an
Idempotency-Keyheader value was rejected.
Functions§
- parse_
worker_ capabilities - Parse the
workflowsandtagsquery parameters a worker sends. - validate_
idempotency_ key - Validate an
Idempotency-Keyheader value.