Full API reference¶
Look up any HTTP operation of the Weave platform: its path, parameters, security, request body, responses, headers, and the schemas they use. This page is for integration developers who already know which operation they need. It is read-only: nothing here sends a request.
New to the API? Start with Use the HTTP API. It explains the tenant, project, and environment IDs in every path, how to get an access token, and walks you through a first read-only request. To send requests from your browser, use your installation's API playground.
How to find what you need. Operations are grouped by area, such as Compiler, Runs, or Human Tasks. Open one to see:
- its method, path, and operation ID, such as
compiler.compile; the same IDs appear in the operation inventory, the CLI help, and the native OpenAPI export; - a Required capability line: the grant your identity needs in that scope (public endpoints, such as health and published sign-in settings, need none);
- the complete contract as JSON, with every schema reference linked to its definition under Schemas at the end of the page.
The published documentation builds this reference from the same contract as the running API, so it matches the release the site describes. If you are reading this Markdown on GitHub, the list below is empty: open the published API reference or export the same OpenAPI document locally.
Download the OpenAPI JSON. This reference is generated from the same contract as the running API.
Operations¶
Choose an operation to inspect its complete parameters, security, request body, responses and headers. Schema references link to the definitions below. To make a request, use your installation's API playground.
Activations¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/activations — activations list
Operation: activations.list
Required capability: catalog.read. Current local scoped grants are authoritative.
{
"description": "Required capability: catalog.read. Current local scoped grants are authoritative.",
"operationId": "activations.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Activation_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "activations list",
"tags": [
"activations"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/activations — activations create
Operation: activations.create
Required capability: release.activate. Current local scoped grants are authoritative.
{
"description": "Required capability: release.activate. Current local scoped grants are authoritative.",
"operationId": "activations.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "If-Match",
"required": false,
"schema": {
"$ref": "#/components/schemas/RevisionTag"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivationRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Activation"
}
}
},
"description": "Success",
"headers": {
"ETag": {
"schema": {
"$ref": "#/components/schemas/CanonicalRevisionTag"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "activations create",
"tags": [
"activations"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/activations/{identifier} — activations read
Operation: activations.read
Required capability: catalog.read. Current local scoped grants are authoritative.
{
"description": "Required capability: catalog.read. Current local scoped grants are authoritative.",
"operationId": "activations.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Activation"
}
}
},
"description": "Success",
"headers": {
"ETag": {
"schema": {
"$ref": "#/components/schemas/CanonicalRevisionTag"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "activations read",
"tags": [
"activations"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/activations/{identifier}/export — activations export
Operation: activations.export
Required capability: catalog.read. Current local scoped grants are authoritative.
{
"description": "Required capability: catalog.read. Current local scoped grants are authoritative.",
"operationId": "activations.export",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivationExport"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "activations export",
"tags": [
"activations"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/activations/{identifier}/retire — activations retire
Operation: activations.retire
Required capability: release.retire. Current local scoped grants are authoritative.
{
"description": "Required capability: release.retire. Current local scoped grants are authoritative.",
"operationId": "activations.retire",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "If-Match",
"required": true,
"schema": {
"$ref": "#/components/schemas/RevisionTag"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetirementRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Activation"
}
}
},
"description": "Success",
"headers": {
"ETag": {
"schema": {
"$ref": "#/components/schemas/CanonicalRevisionTag"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "activations retire",
"tags": [
"activations"
]
}Admin¶
POST /admin/grants — admin grant
Operation: admin.grant
Required capability: grant.admin or grant.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: grant.admin or grant.manage. Current local scoped grants are authoritative.",
"operationId": "admin.grant",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GrantRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Identifier"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "admin grant",
"tags": [
"admin"
]
}POST /admin/tenants — admin tenant
Operation: admin.tenant
Required capability: tenant.create. Current local scoped grants are authoritative.
{
"description": "Required capability: tenant.create. Current local scoped grants are authoritative.",
"operationId": "admin.tenant",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NameRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Identifier"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "admin tenant",
"tags": [
"admin"
]
}Broker Triggers¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/broker-incidents — broker_triggers incidents
Operation: broker_triggers.incidents
Required capability: trigger.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: trigger.manage. Current local scoped grants are authoritative.",
"operationId": "broker_triggers.incidents",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_BrokerIncident_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "broker_triggers incidents",
"tags": [
"broker_triggers"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/broker-triggers — broker_triggers list
Operation: broker_triggers.list
Required capability: trigger.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: trigger.manage. Current local scoped grants are authoritative.",
"operationId": "broker_triggers.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_BrokerTrigger_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "broker_triggers list",
"tags": [
"broker_triggers"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/broker-triggers — broker_triggers create
Operation: broker_triggers.create
Required capability: trigger.manage and connection.manage and connection.bind and target authority. Current local scoped grants are authoritative.
{
"description": "Required capability: trigger.manage and connection.manage and connection.bind and target authority. Current local scoped grants are authoritative.",
"operationId": "broker_triggers.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrokerTriggerRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrokerTrigger"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "broker_triggers create",
"tags": [
"broker_triggers"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/broker-triggers/{identifier} — broker_triggers read
Operation: broker_triggers.read
Required capability: trigger.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: trigger.manage. Current local scoped grants are authoritative.",
"operationId": "broker_triggers.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrokerTrigger"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "broker_triggers read",
"tags": [
"broker_triggers"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/broker-triggers/{identifier}/disable — broker_triggers disable
Operation: broker_triggers.disable
Required capability: trigger.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: trigger.manage. Current local scoped grants are authoritative.",
"operationId": "broker_triggers.disable",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrokerTrigger"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "broker_triggers disable",
"tags": [
"broker_triggers"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/broker-triggers/{identifier}/retry — broker_triggers retry
Operation: broker_triggers.retry
Required capability: trigger.manage and current source authority. Current local scoped grants are authoritative.
{
"description": "Required capability: trigger.manage and current source authority. Current local scoped grants are authoritative.",
"operationId": "broker_triggers.retry",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrokerTrigger"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "broker_triggers retry",
"tags": [
"broker_triggers"
]
}Capabilities¶
GET /api/v1/tenants/{tenant}/projects/{project}/capabilities — capabilities read
Operation: capabilities.read
Required capability: catalog.read. Current local scoped grants are authoritative.
{
"description": "Required capability: catalog.read. Current local scoped grants are authoritative.",
"operationId": "capabilities.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Capabilities"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "capabilities read",
"tags": [
"capabilities"
]
}Catalog¶
GET /api/v1/tenants/{tenant}/projects/{project}/catalog — catalog read
Operation: catalog.read
Required capability: catalog.read. Current local scoped grants are authoritative.
{
"description": "Required capability: catalog.read. Current local scoped grants are authoritative.",
"operationId": "catalog.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CatalogLock-Output"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "catalog read",
"tags": [
"catalog"
]
}Client Configuration¶
GET /api/v1/client-configuration — client_configuration read
Operation: client_configuration.read
Public sign-in settings for CLI and Studio onboarding.
{
"description": "Public sign-in settings for CLI and Studio onboarding.",
"operationId": "client_configuration.read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientConfiguration"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [],
"summary": "client_configuration read",
"tags": [
"client_configuration"
]
}Compatibility¶
GET /api/v1/tenants/{tenant}/projects/{project}/operations/compatibility — compatibility read
Operation: compatibility.read
Required capability: status.read. Current local scoped grants are authoritative.
{
"description": "Required capability: status.read. Current local scoped grants are authoritative.",
"operationId": "compatibility.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompatibilityReport"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "compatibility read",
"tags": [
"compatibility"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/operations/compatibility/check — compatibility check
Operation: compatibility.check
Required capability: compatibility.check. Current local scoped grants are authoritative.
{
"description": "Required capability: compatibility.check. Current local scoped grants are authoritative.",
"operationId": "compatibility.check",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompatibilityReport"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "compatibility check",
"tags": [
"compatibility"
]
}Compiler¶
POST /api/v1/tenants/{tenant}/projects/{project}/compiler/compile — compiler compile
Operation: compiler.compile
Required capability: compile. Current local scoped grants are authoritative.
{
"description": "Required capability: compile. Current local scoped grants are authoritative.",
"operationId": "compiler.compile",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompilerRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompileResponse"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "compiler compile",
"tags": [
"compiler"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/compiler/evaluate-decision — compiler evaluate_decision
Operation: compiler.evaluate_decision
Required capability: compile. Current local scoped grants are authoritative.
{
"description": "Required capability: compile. Current local scoped grants are authoritative.",
"operationId": "compiler.evaluate_decision",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DecisionEvaluationRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DecisionEvaluation"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "compiler evaluate_decision",
"tags": [
"compiler"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/compiler/validate — compiler validate
Operation: compiler.validate
Required capability: compile. Current local scoped grants are authoritative.
{
"description": "Required capability: compile. Current local scoped grants are authoritative.",
"operationId": "compiler.validate",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompilerRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompileResponse"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "compiler validate",
"tags": [
"compiler"
]
}Connections¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/connections — connections list
Operation: connections.list
Required capability: connection.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: connection.manage. Current local scoped grants are authoritative.",
"operationId": "connections.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Union_ConnectionRevision__UnavailableResource__"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "connections list",
"tags": [
"connections"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/connections — connections create
Operation: connections.create
Required capability: connection.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: connection.manage. Current local scoped grants are authoritative.",
"operationId": "connections.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": false,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionRevision"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "connections create",
"tags": [
"connections"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/connections/{identifier} — connections read
Operation: connections.read
Required capability: connection.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: connection.manage. Current local scoped grants are authoritative.",
"operationId": "connections.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionRevision"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "connections read",
"tags": [
"connections"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/connections/{identifier}/test — connections test
Operation: connections.test
Required capability: connection.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: connection.manage. Current local scoped grants are authoritative.",
"operationId": "connections.test",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetirementRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectionTestResult"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "connections test",
"tags": [
"connections"
]
}Connector Descriptors¶
GET /api/v1/tenants/{tenant}/projects/{project}/connector-descriptors — connector_descriptors list
Operation: connector_descriptors.list
Required capability: catalog.read. Current local scoped grants are authoritative.
{
"description": "Required capability: catalog.read. Current local scoped grants are authoritative.",
"operationId": "connector_descriptors.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ConnectorDescriptorView_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "connector_descriptors list",
"tags": [
"connector_descriptors"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/connector-descriptors/{adapter} — connector_descriptors read
Operation: connector_descriptors.read
Required capability: catalog.read. Current local scoped grants are authoritative.
{
"description": "Required capability: catalog.read. Current local scoped grants are authoritative.",
"operationId": "connector_descriptors.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "adapter",
"required": true,
"schema": {
"$ref": "#/components/schemas/AdapterName"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ConnectorDescriptorView"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "connector_descriptors read",
"tags": [
"connector_descriptors"
]
}Debug¶
POST /api/v1/tenants/{tenant}/projects/{project}/debug/sessions — debug create
Operation: debug.create
Required capability: simulate. Current local scoped grants are authoritative.
{
"description": "Required capability: simulate. Current local scoped grants are authoritative.",
"operationId": "debug.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DebugCreate"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DebugSession"
}
}
},
"description": "Success",
"headers": {
"ETag": {
"schema": {
"$ref": "#/components/schemas/CanonicalRevisionTag"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"410": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Expired session",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "debug create",
"tags": [
"debug"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/debug/sessions/{identifier} — debug read
Operation: debug.read
Required capability: simulate. Current local scoped grants are authoritative.
{
"description": "Required capability: simulate. Current local scoped grants are authoritative.",
"operationId": "debug.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DebugSession"
}
}
},
"description": "Success",
"headers": {
"ETag": {
"schema": {
"$ref": "#/components/schemas/CanonicalRevisionTag"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"410": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Expired session",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "debug read",
"tags": [
"debug"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/debug/sessions/{identifier}/commands — debug command
Operation: debug.command
Required capability: simulate. Current local scoped grants are authoritative.
{
"description": "Required capability: simulate. Current local scoped grants are authoritative.",
"operationId": "debug.command",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "If-Match",
"required": true,
"schema": {
"$ref": "#/components/schemas/RevisionTag"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DebugCommand"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DebugSession"
}
}
},
"description": "Success",
"headers": {
"ETag": {
"schema": {
"$ref": "#/components/schemas/CanonicalRevisionTag"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"410": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Expired session",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "debug command",
"tags": [
"debug"
]
}Definitions¶
GET /api/v1/tenants/{tenant}/projects/{project}/{collection} — definitions list
Operation: definitions.list
Required capability: catalog.read. Current local scoped grants are authoritative.
{
"description": "Required capability: catalog.read. Current local scoped grants are authoritative.",
"operationId": "definitions.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"enum": [
"workflows",
"actions",
"connectors",
"decision-tables",
"drafts"
],
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Union_PublishedVersion__Draft__UnavailableResource__"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "definitions list",
"tags": [
"definitions"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/{collection} — definitions publish
Operation: definitions.publish
Required capability: definition.publish. Current local scoped grants are authoritative.
{
"description": "Required capability: definition.publish. Current local scoped grants are authoritative.",
"operationId": "definitions.publish",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"enum": [
"workflows",
"actions",
"connectors",
"decision-tables"
],
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublicationRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PublishedVersion"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "definitions publish",
"tags": [
"definitions"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/{collection}/{identifier} — definitions read
Operation: definitions.read
Required capability: catalog.read. Current local scoped grants are authoritative.
{
"description": "Required capability: catalog.read. Current local scoped grants are authoritative.",
"operationId": "definitions.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"enum": [
"workflows",
"actions",
"connectors",
"decision-tables",
"drafts"
],
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/VersionView"
},
{
"$ref": "#/components/schemas/DraftView"
}
]
}
}
},
"description": "Success",
"headers": {
"ETag": {
"schema": {
"$ref": "#/components/schemas/CanonicalRevisionTag"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "definitions read",
"tags": [
"definitions"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/{collection}/{identifier}/export — definitions export
Operation: definitions.export
Required capability: catalog.read. Current local scoped grants are authoritative.
{
"description": "Required capability: catalog.read. Current local scoped grants are authoritative.",
"operationId": "definitions.export",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"enum": [
"workflows",
"actions",
"connectors",
"decision-tables",
"drafts"
],
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/VersionExport"
},
{
"$ref": "#/components/schemas/DraftExport"
}
]
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "definitions export",
"tags": [
"definitions"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/{collection}/{identifier}/retire — definitions retire
Operation: definitions.retire
Required capability: release.retire. Current local scoped grants are authoritative.
{
"description": "Required capability: release.retire. Current local scoped grants are authoritative.",
"operationId": "definitions.retire",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "collection",
"required": true,
"schema": {
"enum": [
"workflows",
"actions",
"connectors",
"decision-tables"
],
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetirementRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetiredVersion"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "definitions retire",
"tags": [
"definitions"
]
}Deliveries¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deliveries — deliveries list
Operation: deliveries.list
Required capability: delivery.read. Current local scoped grants are authoritative.
{
"description": "Required capability: delivery.read. Current local scoped grants are authoritative.",
"operationId": "deliveries.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DeliveryView_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deliveries list",
"tags": [
"deliveries"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deliveries/{identifier} — deliveries read
Operation: deliveries.read
Required capability: delivery.read. Current local scoped grants are authoritative.
{
"description": "Required capability: delivery.read. Current local scoped grants are authoritative.",
"operationId": "deliveries.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeliveryView"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deliveries read",
"tags": [
"deliveries"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deliveries/{identifier}/attempts — deliveries history
Operation: deliveries.history
Required capability: delivery.read. Current local scoped grants are authoritative.
{
"description": "Required capability: delivery.read. Current local scoped grants are authoritative.",
"operationId": "deliveries.history",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DeliveryAttempt_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deliveries history",
"tags": [
"deliveries"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deliveries/{identifier}/retry — deliveries retry
Operation: deliveries.retry
Required capability: delivery.retry and current source authority. Current local scoped grants are authoritative.
{
"description": "Required capability: delivery.retry and current source authority. Current local scoped grants are authoritative.",
"operationId": "deliveries.retry",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeliveryView"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deliveries retry",
"tags": [
"deliveries"
]
}Deployment Jobs¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-jobs — deployment_jobs list
Operation: deployment_jobs.list
Required capability: deployment.read. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.read. Current local scoped grants are authoritative.",
"operationId": "deployment_jobs.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "target_id",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DeploymentJob_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_jobs list",
"tags": [
"deployment_jobs"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-jobs/{identifier} — deployment_jobs read
Operation: deployment_jobs.read
Required capability: deployment.read. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.read. Current local scoped grants are authoritative.",
"operationId": "deployment_jobs.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentJob"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_jobs read",
"tags": [
"deployment_jobs"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-jobs/{identifier}/cancel — deployment_jobs cancel
Operation: deployment_jobs.cancel
Required capability: deployment.cancel. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.cancel. Current local scoped grants are authoritative.",
"operationId": "deployment_jobs.cancel",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JobCancelRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentJob"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_jobs cancel",
"tags": [
"deployment_jobs"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-jobs/{identifier}/reconcile — deployment_jobs reconcile
Operation: deployment_jobs.reconcile
Required capability: deployment.apply and deployment.approve. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.apply and deployment.approve. Current local scoped grants are authoritative.",
"operationId": "deployment_jobs.reconcile",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReconcileJobRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentJob"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_jobs reconcile",
"tags": [
"deployment_jobs"
]
}Deployment Observations¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-observations — deployment_observations list
Operation: deployment_observations.list
Required capability: deployment.read. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.read. Current local scoped grants are authoritative.",
"operationId": "deployment_observations.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "target_id",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DeploymentObservation_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_observations list",
"tags": [
"deployment_observations"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-observations — deployment_observations create
Operation: deployment_observations.create
Required capability: deployment.plan. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.plan. Current local scoped grants are authoritative.",
"operationId": "deployment_observations.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObserveRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentJob"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_observations create",
"tags": [
"deployment_observations"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-observations/{identifier} — deployment_observations read
Operation: deployment_observations.read
Required capability: deployment.read. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.read. Current local scoped grants are authoritative.",
"operationId": "deployment_observations.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentObservation"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_observations read",
"tags": [
"deployment_observations"
]
}Deployment Plans¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-plans — deployment_plans list
Operation: deployment_plans.list
Required capability: deployment.read. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.read. Current local scoped grants are authoritative.",
"operationId": "deployment_plans.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "target_id",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "deployment_id",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DeploymentPlan_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_plans list",
"tags": [
"deployment_plans"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-plans — deployment_plans create
Operation: deployment_plans.create
Required capability: deployment.plan. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.plan. Current local scoped grants are authoritative.",
"operationId": "deployment_plans.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentPlan"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_plans create",
"tags": [
"deployment_plans"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-plans/{identifier} — deployment_plans read
Operation: deployment_plans.read
Required capability: deployment.read. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.read. Current local scoped grants are authoritative.",
"operationId": "deployment_plans.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentPlan"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_plans read",
"tags": [
"deployment_plans"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-plans/{identifier}/apply — deployment_plans apply
Operation: deployment_plans.apply
Required capability: deployment.apply. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.apply. Current local scoped grants are authoritative.",
"operationId": "deployment_plans.apply",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplyPlanRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentJob"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_plans apply",
"tags": [
"deployment_plans"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-plans/{identifier}/approval — deployment_plans approval
Operation: deployment_plans.approval
Required capability: deployment.read. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.read. Current local scoped grants are authoritative.",
"operationId": "deployment_plans.approval",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/PlanApproval"
},
{
"type": "null"
}
]
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_plans approval",
"tags": [
"deployment_plans"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-plans/{identifier}/approve — deployment_plans approve
Operation: deployment_plans.approve
Required capability: deployment.approve. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.approve. Current local scoped grants are authoritative.",
"operationId": "deployment_plans.approve",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanApprovalRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanApproval"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_plans approve",
"tags": [
"deployment_plans"
]
}Deployment Runners¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-runners — deployment_runners list
Operation: deployment_runners.list
Required capability: deployment.read. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.read. Current local scoped grants are authoritative.",
"operationId": "deployment_runners.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "target_id",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DeploymentRunner_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_runners list",
"tags": [
"deployment_runners"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-runners — deployment_runners create
Operation: deployment_runners.create
Required capability: runner.register. Current local scoped grants are authoritative.
{
"description": "Required capability: runner.register. Current local scoped grants are authoritative.",
"operationId": "deployment_runners.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunnerRegistration"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentRunner"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_runners create",
"tags": [
"deployment_runners"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-runners/claim — deployment_runners claim
Operation: deployment_runners.claim
Required capability: runner.claim. Current local scoped grants are authoritative.
{
"description": "Required capability: runner.claim. Current local scoped grants are authoritative.",
"operationId": "deployment_runners.claim",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunnerClaimRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentLease"
},
{
"type": "null"
}
]
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_runners claim",
"tags": [
"deployment_runners"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-runners/renew — deployment_runners renew
Operation: deployment_runners.renew
Required capability: runner.renew. Current local scoped grants are authoritative.
{
"description": "Required capability: runner.renew. Current local scoped grants are authoritative.",
"operationId": "deployment_runners.renew",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentLeaseProof"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentLease"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_runners renew",
"tags": [
"deployment_runners"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-runners/report — deployment_runners report
Operation: deployment_runners.report
Required capability: runner.report. Current local scoped grants are authoritative.
{
"description": "Required capability: runner.report. Current local scoped grants are authoritative.",
"operationId": "deployment_runners.report",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunnerReport"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentJob"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_runners report",
"tags": [
"deployment_runners"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-runners/{identifier} — deployment_runners read
Operation: deployment_runners.read
Required capability: deployment.read. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.read. Current local scoped grants are authoritative.",
"operationId": "deployment_runners.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentRunner"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_runners read",
"tags": [
"deployment_runners"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-runners/{identifier}/revoke — deployment_runners revoke
Operation: deployment_runners.revoke
Required capability: target.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: target.manage. Current local scoped grants are authoritative.",
"operationId": "deployment_runners.revoke",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentRunner"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_runners revoke",
"tags": [
"deployment_runners"
]
}Deployment Targets¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-targets — deployment_targets list
Operation: deployment_targets.list
Required capability: deployment.read. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.read. Current local scoped grants are authoritative.",
"operationId": "deployment_targets.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "target_id",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_DeploymentTarget_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_targets list",
"tags": [
"deployment_targets"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-targets — deployment_targets create
Operation: deployment_targets.create
Required capability: target.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: target.manage. Current local scoped grants are authoritative.",
"operationId": "deployment_targets.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TargetRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentTarget"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_targets create",
"tags": [
"deployment_targets"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-targets/{identifier} — deployment_targets read
Operation: deployment_targets.read
Required capability: deployment.read. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.read. Current local scoped grants are authoritative.",
"operationId": "deployment_targets.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentTarget"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_targets read",
"tags": [
"deployment_targets"
]
}PUT /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployment-targets/{identifier} — deployment_targets update
Operation: deployment_targets.update
Required capability: target.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: target.manage. Current local scoped grants are authoritative.",
"operationId": "deployment_targets.update",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "If-Match",
"required": true,
"schema": {
"$ref": "#/components/schemas/RevisionTag"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TargetUpdate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentTarget"
}
}
},
"description": "Success",
"headers": {
"ETag": {
"schema": {
"$ref": "#/components/schemas/CanonicalRevisionTag"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployment_targets update",
"tags": [
"deployment_targets"
]
}Deployments¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployments — deployments list
Operation: deployments.list
Required capability: deployment.read. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.read. Current local scoped grants are authoritative.",
"operationId": "deployments.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "target_id",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Deployment_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployments list",
"tags": [
"deployments"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployments — deployments create
Operation: deployments.create
Required capability: target.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: target.manage. Current local scoped grants are authoritative.",
"operationId": "deployments.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Deployment"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployments create",
"tags": [
"deployments"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployments/{identifier} — deployments read
Operation: deployments.read
Required capability: deployment.read. Current local scoped grants are authoritative.
{
"description": "Required capability: deployment.read. Current local scoped grants are authoritative.",
"operationId": "deployments.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Deployment"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployments read",
"tags": [
"deployments"
]
}PUT /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/deployments/{identifier} — deployments update
Operation: deployments.update
Required capability: target.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: target.manage. Current local scoped grants are authoritative.",
"operationId": "deployments.update",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "If-Match",
"required": true,
"schema": {
"$ref": "#/components/schemas/RevisionTag"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeploymentRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Deployment"
}
}
},
"description": "Success",
"headers": {
"ETag": {
"schema": {
"$ref": "#/components/schemas/CanonicalRevisionTag"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "deployments update",
"tags": [
"deployments"
]
}Drafts¶
DELETE /api/v1/tenants/{tenant}/projects/{project}/drafts/{identifier} — drafts retire
Operation: drafts.retire
Required capability: definition.write. Current local scoped grants are authoritative.
{
"description": "Required capability: definition.write. Current local scoped grants are authoritative.",
"operationId": "drafts.retire",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "If-Match",
"required": true,
"schema": {
"$ref": "#/components/schemas/RevisionTag"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DraftRetirement"
}
}
},
"description": "Success",
"headers": {
"ETag": {
"schema": {
"$ref": "#/components/schemas/CanonicalRevisionTag"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "drafts retire",
"tags": [
"drafts"
]
}PUT /api/v1/tenants/{tenant}/projects/{project}/drafts/{identifier} — drafts save
Operation: drafts.save
Required capability: definition.write. Current local scoped grants are authoritative.
{
"description": "Required capability: definition.write. Current local scoped grants are authoritative.",
"operationId": "drafts.save",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "If-Match",
"required": false,
"schema": {
"$ref": "#/components/schemas/RevisionTag"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DraftRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Draft"
}
}
},
"description": "Success",
"headers": {
"ETag": {
"schema": {
"$ref": "#/components/schemas/CanonicalRevisionTag"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Draft"
}
}
},
"description": "Success",
"headers": {
"ETag": {
"schema": {
"$ref": "#/components/schemas/CanonicalRevisionTag"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "drafts save",
"tags": [
"drafts"
]
}Email Conversations¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/email/conversations — email_conversations list
Operation: email_conversations.list
Required capability: email.read. Current local scoped grants are authoritative.
{
"description": "Required capability: email.read. Current local scoped grants are authoritative.",
"operationId": "email_conversations.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EmailConversation_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "email_conversations list",
"tags": [
"email_conversations"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/email/conversations/{identifier} — email_conversations read
Operation: email_conversations.read
Required capability: email.read. Current local scoped grants are authoritative.
{
"description": "Required capability: email.read. Current local scoped grants are authoritative.",
"operationId": "email_conversations.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailConversationDetail"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "email_conversations read",
"tags": [
"email_conversations"
]
}Email Receipts¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/email/receipts — email_receipts list
Operation: email_receipts.list
Required capability: email.read. Current local scoped grants are authoritative.
{
"description": "Required capability: email.read. Current local scoped grants are authoritative.",
"operationId": "email_receipts.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_EmailReceipt_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "email_receipts list",
"tags": [
"email_receipts"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/email/receipts/{identifier}/correlate — email_receipts correlate
Operation: email_receipts.correlate
Required capability: email.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: email.manage. Current local scoped grants are authoritative.",
"operationId": "email_receipts.correlate",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailCorrelationRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailSourceStatus"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "email_receipts correlate",
"tags": [
"email_receipts"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/email/receipts/{identifier}/dispatch — email_receipts dispatch
Operation: email_receipts.dispatch
Required capability: email.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: email.manage. Current local scoped grants are authoritative.",
"operationId": "email_receipts.dispatch",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailSourceStatus"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "email_receipts dispatch",
"tags": [
"email_receipts"
]
}Email Sources¶
POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/email/sources — email_sources create
Operation: email_sources.create
Required capability: email.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: email.manage. Current local scoped grants are authoritative.",
"operationId": "email_sources.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailSourceRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailSourceResult"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "email_sources create",
"tags": [
"email_sources"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/email/sources/{identifier}/poll — email_sources poll
Operation: email_sources.poll
Required capability: email.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: email.manage. Current local scoped grants are authoritative.",
"operationId": "email_sources.poll",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailSourceStatus"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "email_sources poll",
"tags": [
"email_sources"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/email/sources/{identifier}/rebaseline — email_sources rebaseline
Operation: email_sources.rebaseline
Required capability: email.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: email.manage. Current local scoped grants are authoritative.",
"operationId": "email_sources.rebaseline",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailSourceStatus"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "email_sources rebaseline",
"tags": [
"email_sources"
]
}Email Submissions¶
POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/email/conversations/{identifier}/reply — email_submissions reply
Operation: email_submissions.reply
Required capability: email.send. Current local scoped grants are authoritative.
{
"description": "Required capability: email.send. Current local scoped grants are authoritative.",
"operationId": "email_submissions.reply",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailReplyRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailSubmission"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "email_submissions reply",
"tags": [
"email_submissions"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/email/submissions — email_submissions send
Operation: email_submissions.send
Required capability: email.send. Current local scoped grants are authoritative.
{
"description": "Required capability: email.send. Current local scoped grants are authoritative.",
"operationId": "email_submissions.send",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailSendRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailSubmission"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "email_submissions send",
"tags": [
"email_submissions"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/email/submissions/{identifier} — email_submissions read
Operation: email_submissions.read
Required capability: email.read. Current local scoped grants are authoritative.
{
"description": "Required capability: email.read. Current local scoped grants are authoritative.",
"operationId": "email_submissions.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailSubmission"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "email_submissions read",
"tags": [
"email_submissions"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/email/submissions/{identifier}/execute — email_submissions execute
Operation: email_submissions.execute
Required capability: email.send. Current local scoped grants are authoritative.
{
"description": "Required capability: email.send. Current local scoped grants are authoritative.",
"operationId": "email_submissions.execute",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailSubmission"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "email_submissions execute",
"tags": [
"email_submissions"
]
}Email Tokens¶
POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/email/correlation-tokens — email_tokens create
Operation: email_tokens.create
Required capability: email.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: email.manage. Current local scoped grants are authoritative.",
"operationId": "email_tokens.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailTokenRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailCorrelationToken"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "email_tokens create",
"tags": [
"email_tokens"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/email/correlation-tokens/{identifier}/revoke — email_tokens revoke
Operation: email_tokens.revoke
Required capability: email.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: email.manage. Current local scoped grants are authoritative.",
"operationId": "email_tokens.revoke",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailSourceStatus"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "email_tokens revoke",
"tags": [
"email_tokens"
]
}Environments¶
POST /api/v1/tenants/{tenant}/projects/{project}/environments — environments create
Operation: environments.create
Required capability: environment.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: environment.manage. Current local scoped grants are authoritative.",
"operationId": "environments.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NameRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Identifier"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "environments create",
"tags": [
"environments"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment} — environments read
Operation: environments.read
Required capability: status.read. Current local scoped grants are authoritative.
{
"description": "Required capability: status.read. Current local scoped grants are authoritative.",
"operationId": "environments.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NamedResource"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "environments read",
"tags": [
"environments"
]
}Files¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/files — files list
Operation: files.list
Required capability: file.read. Current local scoped grants are authoritative.
{
"description": "Required capability: file.read. Current local scoped grants are authoritative.",
"operationId": "files.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_FileUpload_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "files list",
"tags": [
"files"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/files — files create
Operation: files.create
Required capability: file.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: file.manage. Current local scoped grants are authoritative.",
"operationId": "files.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileCreate"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileUpload"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "files create",
"tags": [
"files"
]
}DELETE /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/files/{identifier} — files delete
Operation: files.delete
Required capability: file.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: file.manage. Current local scoped grants are authoritative.",
"operationId": "files.delete",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Revoked"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "files delete",
"tags": [
"files"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/files/{identifier} — files read
Operation: files.read
Required capability: file.read. Current local scoped grants are authoritative.
{
"description": "Required capability: file.read. Current local scoped grants are authoritative.",
"operationId": "files.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileUpload"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "files read",
"tags": [
"files"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/files/{identifier}/chunks — files chunk
Operation: files.chunk
Required capability: file.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: file.manage. Current local scoped grants are authoritative.",
"operationId": "files.chunk",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileChunk"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileUpload"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "files chunk",
"tags": [
"files"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/files/{identifier}/download — files download
Operation: files.download
Required capability: file.read. Current local scoped grants are authoritative.
{
"description": "Required capability: file.read. Current local scoped grants are authoritative.",
"operationId": "files.download",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileChunkRead"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileChunk"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "files download",
"tags": [
"files"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/files/{identifier}/finish — files finish
Operation: files.finish
Required capability: file.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: file.manage. Current local scoped grants are authoritative.",
"operationId": "files.finish",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileCommand"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileUpload"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "files finish",
"tags": [
"files"
]
}Health¶
GET /health/live — health live
Operation: health.live
Public health probe.
{
"description": "Public health probe.",
"operationId": "health.live",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Health"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [],
"summary": "health live",
"tags": [
"health"
]
}GET /health/ready — health ready
Operation: health.ready
Public health probe.
{
"description": "Public health probe.",
"operationId": "health.ready",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Health"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"503": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Unavailable",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [],
"summary": "health ready",
"tags": [
"health"
]
}Human Assignments¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/human-assignments — human_assignments list
Operation: human_assignments.list
Required capability: assignment.read. Current local scoped grants are authoritative.
{
"description": "Required capability: assignment.read. Current local scoped grants are authoritative.",
"operationId": "human_assignments.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignmentBindingList"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "human_assignments list",
"tags": [
"human_assignments"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/human-assignments — human_assignments put
Operation: human_assignments.put
Required capability: assignment.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: assignment.manage. Current local scoped grants are authoritative.",
"operationId": "human_assignments.put",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignmentBindingRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssignmentBinding"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "human_assignments put",
"tags": [
"human_assignments"
]
}Human Files¶
POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/human-tasks/{identifier}/files/chunk — human_files chunk
Operation: human_files.chunk
Required capability: human_task.complete. Current local scoped grants are authoritative.
{
"description": "Required capability: human_task.complete. Current local scoped grants are authoritative.",
"operationId": "human_files.chunk",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HumanFileChunk"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileUpload"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "human_files chunk",
"tags": [
"human_files"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/human-tasks/{identifier}/files/create — human_files create
Operation: human_files.create
Required capability: human_task.complete. Current local scoped grants are authoritative.
{
"description": "Required capability: human_task.complete. Current local scoped grants are authoritative.",
"operationId": "human_files.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HumanFileCreate"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileUpload"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "human_files create",
"tags": [
"human_files"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/human-tasks/{identifier}/files/download — human_files download
Operation: human_files.download
Required capability: human_task.read. Current local scoped grants are authoritative.
{
"description": "Required capability: human_task.read. Current local scoped grants are authoritative.",
"operationId": "human_files.download",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HumanFileRead"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileChunk"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "human_files download",
"tags": [
"human_files"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/human-tasks/{identifier}/files/finish — human_files finish
Operation: human_files.finish
Required capability: human_task.complete. Current local scoped grants are authoritative.
{
"description": "Required capability: human_task.complete. Current local scoped grants are authoritative.",
"operationId": "human_files.finish",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HumanFileCommand"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileUpload"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "human_files finish",
"tags": [
"human_files"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/human-tasks/{identifier}/files/read — human_files read
Operation: human_files.read
Required capability: human_task.read. Current local scoped grants are authoritative.
{
"description": "Required capability: human_task.read. Current local scoped grants are authoritative.",
"operationId": "human_files.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HumanFileCommand"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileUpload"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "human_files read",
"tags": [
"human_files"
]
}Human Groups¶
POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/human-groups — human_groups put
Operation: human_groups.put
Required capability: assignment.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: assignment.manage. Current local scoped grants are authoritative.",
"operationId": "human_groups.put",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskGroupRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskGroup"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "human_groups put",
"tags": [
"human_groups"
]
}Human Tasks¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/human-tasks — human_tasks list
Operation: human_tasks.list
Required capability: human_task.read. Current local scoped grants are authoritative.
{
"description": "Required capability: human_task.read. Current local scoped grants are authoritative.",
"operationId": "human_tasks.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "status",
"required": false,
"schema": {
"enum": [
"ready",
"claimed",
"completed",
"expired",
"cancelled"
],
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_HumanTask_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "human_tasks list",
"tags": [
"human_tasks"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/human-tasks/{identifier} — human_tasks read
Operation: human_tasks.read
Required capability: human_task.read. Current local scoped grants are authoritative.
{
"description": "Required capability: human_task.read. Current local scoped grants are authoritative.",
"operationId": "human_tasks.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HumanTask"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "human_tasks read",
"tags": [
"human_tasks"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/human-tasks/{identifier}/claim — human_tasks claim
Operation: human_tasks.claim
Required capability: human_task.claim. Current local scoped grants are authoritative.
{
"description": "Required capability: human_task.claim. Current local scoped grants are authoritative.",
"operationId": "human_tasks.claim",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HumanTaskCommand"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HumanTask"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "human_tasks claim",
"tags": [
"human_tasks"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/human-tasks/{identifier}/complete — human_tasks complete
Operation: human_tasks.complete
Required capability: human_task.complete. Current local scoped grants are authoritative.
{
"description": "Required capability: human_task.complete. Current local scoped grants are authoritative.",
"operationId": "human_tasks.complete",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompleteHumanTask"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HumanTask"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "human_tasks complete",
"tags": [
"human_tasks"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/human-tasks/{identifier}/reassign — human_tasks reassign
Operation: human_tasks.reassign
Required capability: human_task.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: human_task.manage. Current local scoped grants are authoritative.",
"operationId": "human_tasks.reassign",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReassignHumanTask"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HumanTask"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "human_tasks reassign",
"tags": [
"human_tasks"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/human-tasks/{identifier}/release — human_tasks release
Operation: human_tasks.release
Required capability: human_task.release. Current local scoped grants are authoritative.
{
"description": "Required capability: human_task.release. Current local scoped grants are authoritative.",
"operationId": "human_tasks.release",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HumanTaskCommand"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HumanTask"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "human_tasks release",
"tags": [
"human_tasks"
]
}Identity¶
GET /api/v1/identity — identity read
Operation: identity.read
Required capability: authenticated identity. Current local scoped grants are authoritative.
{
"description": "Required capability: authenticated identity. Current local scoped grants are authoritative.",
"operationId": "identity.read",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IdentityView"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "identity read",
"tags": [
"identity"
]
}Incidents¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/incidents — incidents list
Operation: incidents.list
Required capability: incident.read. Current local scoped grants are authoritative.
{
"description": "Required capability: incident.read. Current local scoped grants are authoritative.",
"operationId": "incidents.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Union_IncidentView__UnavailableResource__"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "incidents list",
"tags": [
"incidents"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/incidents/{identifier}/resolve — incidents resolve
Operation: incidents.resolve
Required capability: incident.resolve. Current local scoped grants are authoritative.
{
"description": "Required capability: incident.resolve. Current local scoped grants are authoritative.",
"operationId": "incidents.resolve",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "If-Match",
"required": true,
"schema": {
"$ref": "#/components/schemas/RevisionTag"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IncidentResolution-Input"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IncidentView"
}
}
},
"description": "Success",
"headers": {
"ETag": {
"schema": {
"$ref": "#/components/schemas/CanonicalRevisionTag"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "incidents resolve",
"tags": [
"incidents"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/runs/{identifier}/incidents — incidents run_list
Operation: incidents.run_list
Required capability: incident.read. Current local scoped grants are authoritative.
{
"description": "Required capability: incident.read. Current local scoped grants are authoritative.",
"operationId": "incidents.run_list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Union_IncidentView__UnavailableResource__"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "incidents run_list",
"tags": [
"incidents"
]
}Language¶
GET /api/v1/tenants/{tenant}/projects/{project}/language — language read
Operation: language.read
Required capability: catalog.read. Current local scoped grants are authoritative.
{
"description": "Required capability: catalog.read. Current local scoped grants are authoritative.",
"operationId": "language.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LanguageManifest"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "language read",
"tags": [
"language"
]
}Lumi¶
POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/lumi/ask — lumi ask
Operation: lumi.ask
Required capability: lumi.use. Current local scoped grants are authoritative.
{
"description": "Required capability: lumi.use. Current local scoped grants are authoritative.",
"operationId": "lumi.ask",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LumiAskRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LumiReply"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "lumi ask",
"tags": [
"lumi"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/lumi/configuration — lumi configuration read
Operation: lumi.configuration.read
Required capability: lumi.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: lumi.manage. Current local scoped grants are authoritative.",
"operationId": "lumi.configuration.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LumiConfiguration"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "lumi configuration read",
"tags": [
"lumi"
]
}PUT /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/lumi/configuration — lumi configuration write
Operation: lumi.configuration.write
Required capability: lumi.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: lumi.manage. Current local scoped grants are authoritative.",
"operationId": "lumi.configuration.write",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "If-Match",
"required": false,
"schema": {
"$ref": "#/components/schemas/RevisionTag"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LumiConfigurationRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LumiConfiguration"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "lumi configuration write",
"tags": [
"lumi"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/lumi/status — lumi status
Operation: lumi.status
Required capability: lumi.use. Current local scoped grants are authoritative.
{
"description": "Required capability: lumi.use. Current local scoped grants are authoritative.",
"operationId": "lumi.status",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LumiStatus"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "lumi status",
"tags": [
"lumi"
]
}Members¶
GET /api/v1/tenants/{tenant}/members — members list
Operation: members.list
Required capability: grant.manage or grant.admin. Current local scoped grants are authoritative.
{
"description": "Required capability: grant.manage or grant.admin. Current local scoped grants are authoritative.",
"operationId": "members.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_MemberBinding_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "members list",
"tags": [
"members"
]
}POST /api/v1/tenants/{tenant}/members — members grant
Operation: members.grant
Required capability: grant.manage or grant.admin. Current local scoped grants are authoritative.
{
"description": "Required capability: grant.manage or grant.admin. Current local scoped grants are authoritative.",
"operationId": "members.grant",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberGrantRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MemberBinding"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "members grant",
"tags": [
"members"
]
}POST /api/v1/tenants/{tenant}/members/{identifier}/revoke — members revoke
Operation: members.revoke
Required capability: grant.manage or grant.admin. Current local scoped grants are authoritative.
{
"description": "Required capability: grant.manage or grant.admin. Current local scoped grants are authoritative.",
"operationId": "members.revoke",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Revoked"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "members revoke",
"tags": [
"members"
]
}Principals¶
GET /api/v1/admin/principals — principals list
Operation: principals.list
Required capability: grant.admin. Current local scoped grants are authoritative.
{
"description": "Required capability: grant.admin. Current local scoped grants are authoritative.",
"operationId": "principals.list",
"parameters": [
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_PrincipalRecord_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "principals list",
"tags": [
"principals"
]
}POST /api/v1/admin/principals — principals create
Operation: principals.create
Required capability: grant.admin. Current local scoped grants are authoritative.
{
"description": "Required capability: grant.admin. Current local scoped grants are authoritative.",
"operationId": "principals.create",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrincipalCreateRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrincipalRecord"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "principals create",
"tags": [
"principals"
]
}POST /api/v1/admin/principals/{identifier}/identity-links — principals link
Operation: principals.link
Required capability: grant.admin. Current local scoped grants are authoritative.
{
"description": "Required capability: grant.admin. Current local scoped grants are authoritative.",
"operationId": "principals.link",
"parameters": [
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrincipalIdentityRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrincipalIdentityResult"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "principals link",
"tags": [
"principals"
]
}POST /api/v1/admin/principals/{identifier}/status — principals status
Operation: principals.status
Required capability: grant.admin. Current local scoped grants are authoritative.
{
"description": "Required capability: grant.admin. Current local scoped grants are authoritative.",
"operationId": "principals.status",
"parameters": [
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrincipalStatusRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PrincipalRecord"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "principals status",
"tags": [
"principals"
]
}Projects¶
POST /api/v1/tenants/{tenant}/projects — projects create
Operation: projects.create
Required capability: project.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: project.manage. Current local scoped grants are authoritative.",
"operationId": "projects.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NameRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Identifier"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "projects create",
"tags": [
"projects"
]
}Provider Ingress¶
GET /provider-ingress/{identifier} — provider_ingress challenge
Operation: provider_ingress.challenge
Required capability: provider challenge verification. Current local scoped grants are authoritative.
{
"description": "Required capability: provider challenge verification. Current local scoped grants are authoritative.",
"operationId": "provider_ingress.challenge",
"parameters": [
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
},
"text/plain": {
"schema": {
"type": "string"
}
}
},
"description": "Authenticated provider ACK after durable admission; provider-specific body",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {}
},
"text/plain": {
"schema": {
"type": "string"
}
}
},
"description": "Authenticated provider ACK after durable admission; provider-specific body",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"202": {
"content": {
"application/json": {
"schema": {}
},
"text/plain": {
"schema": {
"type": "string"
}
}
},
"description": "Authenticated provider ACK after durable admission; provider-specific body",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"204": {
"content": {
"application/json": {
"schema": {}
},
"text/plain": {
"schema": {
"type": "string"
}
}
},
"description": "Authenticated provider ACK after durable admission; provider-specific body",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"2XX": {
"content": {
"application/json": {
"schema": {}
},
"text/plain": {
"schema": {
"type": "string"
}
}
},
"description": "Authenticated provider ACK after durable admission; provider-specific body",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [],
"summary": "provider_ingress challenge",
"tags": [
"provider_ingress"
]
}POST /provider-ingress/{identifier} — provider_ingress receive
Operation: provider_ingress.receive
Required capability: provider verification. Current local scoped grants are authoritative.
{
"description": "Required capability: provider verification. Current local scoped grants are authoritative.",
"operationId": "provider_ingress.receive",
"parameters": [
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"format": "binary",
"type": "string"
}
},
"application/octet-stream": {
"schema": {
"format": "binary",
"type": "string"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {}
},
"text/plain": {
"schema": {
"type": "string"
}
}
},
"description": "Authenticated provider ACK after durable admission; provider-specific body",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"201": {
"content": {
"application/json": {
"schema": {}
},
"text/plain": {
"schema": {
"type": "string"
}
}
},
"description": "Authenticated provider ACK after durable admission; provider-specific body",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"202": {
"content": {
"application/json": {
"schema": {}
},
"text/plain": {
"schema": {
"type": "string"
}
}
},
"description": "Authenticated provider ACK after durable admission; provider-specific body",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"204": {
"content": {
"application/json": {
"schema": {}
},
"text/plain": {
"schema": {
"type": "string"
}
}
},
"description": "Authenticated provider ACK after durable admission; provider-specific body",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"2XX": {
"content": {
"application/json": {
"schema": {}
},
"text/plain": {
"schema": {
"type": "string"
}
}
},
"description": "Authenticated provider ACK after durable admission; provider-specific body",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [],
"summary": "provider_ingress receive",
"tags": [
"provider_ingress"
]
}Provider Receipts¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/provider-receipts — provider_receipts list
Operation: provider_receipts.list
Required capability: run.read. Current local scoped grants are authoritative.
{
"description": "Required capability: run.read. Current local scoped grants are authoritative.",
"operationId": "provider_receipts.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ProviderReceipt_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "provider_receipts list",
"tags": [
"provider_receipts"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/provider-receipts/{identifier} — provider_receipts read
Operation: provider_receipts.read
Required capability: run.read. Current local scoped grants are authoritative.
{
"description": "Required capability: run.read. Current local scoped grants are authoritative.",
"operationId": "provider_receipts.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderReceipt"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "provider_receipts read",
"tags": [
"provider_receipts"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/provider-receipts/{identifier}/retry — provider_receipts retry
Operation: provider_receipts.retry
Required capability: run.retry + current source/target authority. Current local scoped grants are authoritative.
{
"description": "Required capability: run.retry + current source/target authority. Current local scoped grants are authoritative.",
"operationId": "provider_receipts.retry",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderReceipt"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "provider_receipts retry",
"tags": [
"provider_receipts"
]
}Provider Sources¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/provider-sources — provider_sources list
Operation: provider_sources.list
Required capability: run.read. Current local scoped grants are authoritative.
{
"description": "Required capability: run.read. Current local scoped grants are authoritative.",
"operationId": "provider_sources.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ProviderSource_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "provider_sources list",
"tags": [
"provider_sources"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/provider-sources — provider_sources create
Operation: provider_sources.create
Required capability: trigger.manage + connection.manage + connection.bind + target authority. Current local scoped grants are authoritative.
{
"description": "Required capability: trigger.manage + connection.manage + connection.bind + target authority. Current local scoped grants are authoritative.",
"operationId": "provider_sources.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderSourceRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderSource"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "provider_sources create",
"tags": [
"provider_sources"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/provider-sources/{identifier} — provider_sources read
Operation: provider_sources.read
Required capability: run.read. Current local scoped grants are authoritative.
{
"description": "Required capability: run.read. Current local scoped grants are authoritative.",
"operationId": "provider_sources.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderSource"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "provider_sources read",
"tags": [
"provider_sources"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/provider-sources/{identifier}/disable — provider_sources disable
Operation: provider_sources.disable
Required capability: trigger.manage + connection.bind + target authority. Current local scoped grants are authoritative.
{
"description": "Required capability: trigger.manage + connection.bind + target authority. Current local scoped grants are authoritative.",
"operationId": "provider_sources.disable",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProviderSource"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "provider_sources disable",
"tags": [
"provider_sources"
]
}Releases¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/worker-releases — releases list
Operation: releases.list
Required capability: catalog.read. Current local scoped grants are authoritative.
{
"description": "Required capability: catalog.read. Current local scoped grants are authoritative.",
"operationId": "releases.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_WorkerRelease_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "releases list",
"tags": [
"releases"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/worker-releases — releases create
Operation: releases.create
Required capability: release.activate. Current local scoped grants are authoritative.
{
"description": "Required capability: release.activate. Current local scoped grants are authoritative.",
"operationId": "releases.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReleaseRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerRelease"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "releases create",
"tags": [
"releases"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/worker-releases/{identifier} — releases read
Operation: releases.read
Required capability: catalog.read. Current local scoped grants are authoritative.
{
"description": "Required capability: catalog.read. Current local scoped grants are authoritative.",
"operationId": "releases.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerRelease"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "releases read",
"tags": [
"releases"
]
}Retention¶
POST /api/v1/tenants/{tenant}/projects/{project}/operations/retention/plans — retention plan
Operation: retention.plan
Required capability: retention.plan. Current local scoped grants are authoritative.
{
"description": "Required capability: retention.plan. Current local scoped grants are authoritative.",
"operationId": "retention.plan",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetentionRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetentionPlan"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "retention plan",
"tags": [
"retention"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/operations/retention/plans/{identifier} — retention read
Operation: retention.read
Required capability: retention.plan. Current local scoped grants are authoritative.
{
"description": "Required capability: retention.plan. Current local scoped grants are authoritative.",
"operationId": "retention.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetentionPlan"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "retention read",
"tags": [
"retention"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/operations/retention/plans/{identifier}/apply — retention apply
Operation: retention.apply
Required capability: retention.apply. Current local scoped grants are authoritative.
{
"description": "Required capability: retention.apply. Current local scoped grants are authoritative.",
"operationId": "retention.apply",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RetentionApplication"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "retention apply",
"tags": [
"retention"
]
}Run Summaries¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/run-summaries — run_summaries list
Operation: run_summaries.list
Required capability: run.read. Current local scoped grants are authoritative. Published contract: this server answers 501 WV-UNAVAILABLE until it serves it.
{
"description": "Required capability: run.read. Current local scoped grants are authoritative. Published contract: this server answers 501 WV-UNAVAILABLE until it serves it.",
"operationId": "run_summaries.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "workflow",
"required": false,
"schema": {
"$ref": "#/components/schemas/ResourceName"
}
},
{
"in": "query",
"name": "version",
"required": false,
"schema": {
"$ref": "#/components/schemas/SemVer"
}
},
{
"in": "query",
"name": "status",
"required": false,
"schema": {
"$ref": "#/components/schemas/StatusFilter"
}
},
{
"in": "query",
"name": "origin",
"required": false,
"schema": {
"$ref": "#/components/schemas/RunOrigin"
}
},
{
"in": "query",
"name": "started_after",
"required": false,
"schema": {
"format": "date-time",
"type": "string"
}
},
{
"in": "query",
"name": "started_before",
"required": false,
"schema": {
"format": "date-time",
"type": "string"
}
},
{
"in": "query",
"name": "include_test",
"required": false,
"schema": {
"default": false,
"type": "boolean"
}
},
{
"in": "query",
"name": "caller_run_id",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "top_level_only",
"required": false,
"schema": {
"default": false,
"type": "boolean"
}
},
{
"in": "query",
"name": "retried_from_run_id",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "business_key",
"required": false,
"schema": {
"$ref": "#/components/schemas/BusinessKey"
}
},
{
"in": "query",
"name": "correlation_key",
"required": false,
"schema": {
"$ref": "#/components/schemas/BusinessKey"
}
},
{
"in": "query",
"name": "has_active_incident",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"in": "query",
"name": "include_archived",
"required": false,
"schema": {
"default": false,
"type": "boolean"
}
},
{
"in": "query",
"name": "activation_id",
"required": false,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "order",
"required": false,
"schema": {
"$ref": "#/components/schemas/RunSummaryOrder",
"default": "started_desc"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/SummaryLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"$ref": "#/components/schemas/Cursor"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunSummaryPage"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"501": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Not served by this server yet",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "run_summaries list",
"tags": [
"run_summaries"
]
}Runs¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/runs — runs list
Operation: runs.list
Required capability: run.read. Current local scoped grants are authoritative.
{
"description": "Required capability: run.read. Current local scoped grants are authoritative.",
"operationId": "runs.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "business_key",
"required": false,
"schema": {
"maxLength": 200,
"type": "string"
}
},
{
"in": "query",
"name": "correlation_key",
"required": false,
"schema": {
"maxLength": 200,
"type": "string"
}
},
{
"in": "query",
"name": "status",
"required": false,
"schema": {
"enum": [
"queued",
"running",
"waiting",
"suspended",
"succeeded",
"failed",
"cancelled",
"timed_out"
],
"type": "string"
}
},
{
"in": "query",
"name": "include_archived",
"required": false,
"schema": {
"default": false,
"type": "boolean"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Union_RunView__UnavailableResource__"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "runs list",
"tags": [
"runs"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/runs — runs start
Operation: runs.start
Required capability: run.start. Current local scoped grants are authoritative.
{
"description": "Required capability: run.start. Current local scoped grants are authoritative.",
"operationId": "runs.start",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartRunRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunView"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "runs start",
"tags": [
"runs"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/runs/{identifier} — runs read
Operation: runs.read
Required capability: run.read. Current local scoped grants are authoritative.
{
"description": "Required capability: run.read. Current local scoped grants are authoritative.",
"operationId": "runs.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunView"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "runs read",
"tags": [
"runs"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/runs/{identifier}/archive — runs archive
Operation: runs.archive
Required capability: run.archive. Current local scoped grants are authoritative.
{
"description": "Required capability: run.archive. Current local scoped grants are authoritative.",
"operationId": "runs.archive",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunLifecycleRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunLifecycle"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "runs archive",
"tags": [
"runs"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/runs/{identifier}/cancel — runs cancel
Operation: runs.cancel
Required capability: run.cancel. Current local scoped grants are authoritative.
{
"description": "Required capability: run.cancel. Current local scoped grants are authoritative.",
"operationId": "runs.cancel",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelRunRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/RunView"
},
{
"$ref": "#/components/schemas/UnavailableRunAcknowledgment"
},
{
"$ref": "#/components/schemas/CapacityRunAcknowledgment"
}
]
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "runs cancel",
"tags": [
"runs"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/runs/{identifier}/export — runs export
Operation: runs.export
Required capability: run.read. Current local scoped grants are authoritative.
{
"description": "Required capability: run.read. Current local scoped grants are authoritative.",
"operationId": "runs.export",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 1000,
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HistoryExport"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "runs export",
"tags": [
"runs"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/runs/{identifier}/history — runs history
Operation: runs.history
Required capability: run.read. Current local scoped grants are authoritative.
{
"description": "Required capability: run.read. Current local scoped grants are authoritative.",
"operationId": "runs.history",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 100,
"maximum": 100,
"minimum": 1,
"type": "integer"
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventPage"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "runs history",
"tags": [
"runs"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/runs/{identifier}/lifecycle — runs lifecycle
Operation: runs.lifecycle
Required capability: run.read. Current local scoped grants are authoritative.
{
"description": "Required capability: run.read. Current local scoped grants are authoritative.",
"operationId": "runs.lifecycle",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunLifecycle"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "runs lifecycle",
"tags": [
"runs"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/runs/{identifier}/logs — runs logs
Operation: runs.logs
Required capability: run.read. Current local scoped grants are authoritative. Published contract: this server answers 501 WV-UNAVAILABLE until it serves it.
{
"description": "Required capability: run.read. Current local scoped grants are authoritative. Published contract: this server answers 501 WV-UNAVAILABLE until it serves it.",
"operationId": "runs.logs",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "level",
"required": false,
"schema": {
"$ref": "#/components/schemas/LogLevel"
}
},
{
"in": "query",
"name": "source",
"required": false,
"schema": {
"$ref": "#/components/schemas/LogSource"
}
},
{
"in": "query",
"name": "node_id",
"required": false,
"schema": {
"$ref": "#/components/schemas/ResourceName"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/DetailLimit",
"default": 200
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"$ref": "#/components/schemas/Cursor"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunLogPage"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"501": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Not served by this server yet",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "runs logs",
"tags": [
"runs"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/runs/{identifier}/pause — runs pause
Operation: runs.pause
Required capability: run.pause. Current local scoped grants are authoritative.
{
"description": "Required capability: run.pause. Current local scoped grants are authoritative.",
"operationId": "runs.pause",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManualControlRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunView"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "runs pause",
"tags": [
"runs"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/runs/{identifier}/purge — runs purge
Operation: runs.purge
Required capability: run.purge. Current local scoped grants are authoritative.
{
"description": "Required capability: run.purge. Current local scoped grants are authoritative.",
"operationId": "runs.purge",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunPurgeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunLifecycle"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "runs purge",
"tags": [
"runs"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/runs/{identifier}/replay — runs replay
Operation: runs.replay
Required capability: run.read. Current local scoped grants are authoritative.
{
"description": "Required capability: run.read. Current local scoped grants are authoritative.",
"operationId": "runs.replay",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"default": 1000,
"maximum": 1000,
"minimum": 1,
"type": "integer"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReplayReport"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "runs replay",
"tags": [
"runs"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/runs/{identifier}/restore — runs restore
Operation: runs.restore
Required capability: run.archive. Current local scoped grants are authoritative.
{
"description": "Required capability: run.archive. Current local scoped grants are authoritative.",
"operationId": "runs.restore",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunLifecycleRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunLifecycle"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "runs restore",
"tags": [
"runs"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/runs/{identifier}/resume — runs resume
Operation: runs.resume
Required capability: run.resume. Current local scoped grants are authoritative.
{
"description": "Required capability: run.resume. Current local scoped grants are authoritative.",
"operationId": "runs.resume",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ManualControlRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunView"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "runs resume",
"tags": [
"runs"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/runs/{identifier}/retry — runs retry
Operation: runs.retry
Required capability: run.retry. Current local scoped grants are authoritative.
{
"description": "Required capability: run.retry. Current local scoped grants are authoritative.",
"operationId": "runs.retry",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StartRunRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RunView"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "runs retry",
"tags": [
"runs"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/runs/{identifier}/signals — runs signal
Operation: runs.signal
Required capability: run.signal. Current local scoped grants are authoritative.
{
"description": "Required capability: run.signal. Current local scoped grants are authoritative.",
"operationId": "runs.signal",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SignalRequest"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SignalReceipt"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "runs signal",
"tags": [
"runs"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/runs/{identifier}/steps — runs steps
Operation: runs.steps
Required capability: run.read. Current local scoped grants are authoritative. Published contract: this server answers 501 WV-UNAVAILABLE until it serves it.
{
"description": "Required capability: run.read. Current local scoped grants are authoritative. Published contract: this server answers 501 WV-UNAVAILABLE until it serves it.",
"operationId": "runs.steps",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "step",
"required": false,
"schema": {
"$ref": "#/components/schemas/ResourceName"
}
},
{
"in": "query",
"name": "include",
"required": false,
"schema": {
"const": "output",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/DetailLimit",
"default": 200
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"$ref": "#/components/schemas/Cursor"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StepFactPage"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"501": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Not served by this server yet",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "runs steps",
"tags": [
"runs"
]
}Schedules¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/schedules — schedules list
Operation: schedules.list
Required capability: run.read. Current local scoped grants are authoritative.
{
"description": "Required capability: run.read. Current local scoped grants are authoritative.",
"operationId": "schedules.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ScheduleView_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "schedules list",
"tags": [
"schedules"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/schedules — schedules save
Operation: schedules.save
Required capability: trigger.manage and run.start. Current local scoped grants are authoritative.
{
"description": "Required capability: trigger.manage and run.start. Current local scoped grants are authoritative.",
"operationId": "schedules.save",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "If-Match",
"required": false,
"schema": {
"$ref": "#/components/schemas/RevisionTag"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleView"
}
}
},
"description": "Success",
"headers": {
"ETag": {
"schema": {
"$ref": "#/components/schemas/CanonicalRevisionTag"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "schedules save",
"tags": [
"schedules"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/schedules/{identifier} — schedules read
Operation: schedules.read
Required capability: run.read. Current local scoped grants are authoritative.
{
"description": "Required capability: run.read. Current local scoped grants are authoritative.",
"operationId": "schedules.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleView"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "schedules read",
"tags": [
"schedules"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/schedules/{identifier}/delete — schedules delete
Operation: schedules.delete
Required capability: trigger.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: trigger.manage. Current local scoped grants are authoritative.",
"operationId": "schedules.delete",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "If-Match",
"required": true,
"schema": {
"$ref": "#/components/schemas/RevisionTag"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleView"
}
}
},
"description": "Success",
"headers": {
"ETag": {
"schema": {
"$ref": "#/components/schemas/CanonicalRevisionTag"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "schedules delete",
"tags": [
"schedules"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/schedules/{identifier}/disable — schedules disable
Operation: schedules.disable
Required capability: trigger.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: trigger.manage. Current local scoped grants are authoritative.",
"operationId": "schedules.disable",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "If-Match",
"required": true,
"schema": {
"$ref": "#/components/schemas/RevisionTag"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleView"
}
}
},
"description": "Success",
"headers": {
"ETag": {
"schema": {
"$ref": "#/components/schemas/CanonicalRevisionTag"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "schedules disable",
"tags": [
"schedules"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/schedules/{identifier}/enable — schedules enable
Operation: schedules.enable
Required capability: trigger.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: trigger.manage. Current local scoped grants are authoritative.",
"operationId": "schedules.enable",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "If-Match",
"required": true,
"schema": {
"$ref": "#/components/schemas/RevisionTag"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ScheduleView"
}
}
},
"description": "Success",
"headers": {
"ETag": {
"schema": {
"$ref": "#/components/schemas/CanonicalRevisionTag"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "schedules enable",
"tags": [
"schedules"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/schedules/{identifier}/occurrences — schedules history
Operation: schedules.history
Required capability: run.read. Current local scoped grants are authoritative.
{
"description": "Required capability: run.read. Current local scoped grants are authoritative.",
"operationId": "schedules.history",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_ScheduleOccurrence_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "schedules history",
"tags": [
"schedules"
]
}Schemas¶
GET /api/v1/tenants/{tenant}/projects/{project}/schemas — schemas read
Operation: schemas.read
Required capability: catalog.read. Current local scoped grants are authoritative.
{
"description": "Required capability: catalog.read. Current local scoped grants are authoritative.",
"operationId": "schemas.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"additionalProperties": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"type": "object"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "schemas read",
"tags": [
"schemas"
]
}Source Bindings¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/connection-source-bindings — source_bindings list
Operation: source_bindings.list
Required capability: connection.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: connection.manage. Current local scoped grants are authoritative.",
"operationId": "source_bindings.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_SourceBinding_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "source_bindings list",
"tags": [
"source_bindings"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/connection-source-bindings/{identifier} — source_bindings read
Operation: source_bindings.read
Required capability: connection.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: connection.manage. Current local scoped grants are authoritative.",
"operationId": "source_bindings.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SourceBinding"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "source_bindings read",
"tags": [
"source_bindings"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/connection-source-bindings/{identifier}/revoke — source_bindings revoke
Operation: source_bindings.revoke
Required capability: connection.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: connection.manage. Current local scoped grants are authoritative.",
"operationId": "source_bindings.revoke",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Revoked"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "source_bindings revoke",
"tags": [
"source_bindings"
]
}Subscriptions¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/subscriptions — subscriptions list
Operation: subscriptions.list
Required capability: delivery.read. Current local scoped grants are authoritative.
{
"description": "Required capability: delivery.read. Current local scoped grants are authoritative.",
"operationId": "subscriptions.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Subscription_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "subscriptions list",
"tags": [
"subscriptions"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/subscriptions — subscriptions save
Operation: subscriptions.save
Required capability: subscription.manage and connection.manage and connection.bind and source authority. Current local scoped grants are authoritative.
{
"description": "Required capability: subscription.manage and connection.manage and connection.bind and source authority. Current local scoped grants are authoritative.",
"operationId": "subscriptions.save",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "subscriptions save",
"tags": [
"subscriptions"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/subscriptions/{identifier} — subscriptions read
Operation: subscriptions.read
Required capability: delivery.read. Current local scoped grants are authoritative.
{
"description": "Required capability: delivery.read. Current local scoped grants are authoritative.",
"operationId": "subscriptions.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "subscriptions read",
"tags": [
"subscriptions"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/subscriptions/{identifier}/disable — subscriptions disable
Operation: subscriptions.disable
Required capability: subscription.manage and source authority. Current local scoped grants are authoritative.
{
"description": "Required capability: subscription.manage and source authority. Current local scoped grants are authoritative.",
"operationId": "subscriptions.disable",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "subscriptions disable",
"tags": [
"subscriptions"
]
}Task Files¶
POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/tasks/files/chunk — task_files chunk
Operation: task_files.chunk
Required capability: task.claim. Current local scoped grants are authoritative.
{
"description": "Required capability: task.claim. Current local scoped grants are authoritative.",
"operationId": "task_files.chunk",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerFileChunk"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileUpload"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "task_files chunk",
"tags": [
"task_files"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/tasks/files/create — task_files create
Operation: task_files.create
Required capability: task.claim. Current local scoped grants are authoritative.
{
"description": "Required capability: task.claim. Current local scoped grants are authoritative.",
"operationId": "task_files.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerFileCreate"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileUpload"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "task_files create",
"tags": [
"task_files"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/tasks/files/download — task_files download
Operation: task_files.download
Required capability: task.claim. Current local scoped grants are authoritative.
{
"description": "Required capability: task.claim. Current local scoped grants are authoritative.",
"operationId": "task_files.download",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerFileRead"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileChunk"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "task_files download",
"tags": [
"task_files"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/tasks/files/finish — task_files finish
Operation: task_files.finish
Required capability: task.claim. Current local scoped grants are authoritative.
{
"description": "Required capability: task.claim. Current local scoped grants are authoritative.",
"operationId": "task_files.finish",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerFileAccess"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileUpload"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "task_files finish",
"tags": [
"task_files"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/tasks/files/read — task_files read
Operation: task_files.read
Required capability: task.claim. Current local scoped grants are authoritative.
{
"description": "Required capability: task.claim. Current local scoped grants are authoritative.",
"operationId": "task_files.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerFileAccess"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FileUpload"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "task_files read",
"tags": [
"task_files"
]
}Tasks¶
POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/tasks/claim — tasks claim
Operation: tasks.claim
Required capability: task.claim. Current local scoped grants are authoritative.
{
"description": "Required capability: task.claim. Current local scoped grants are authoritative.",
"operationId": "tasks.claim",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClaimRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/TaskLease"
},
"type": "array"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "tasks claim",
"tags": [
"tasks"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/tasks/complete — tasks complete
Operation: tasks.complete
Required capability: task.complete. Current local scoped grants are authoritative.
{
"description": "Required capability: task.complete. Current local scoped grants are authoritative.",
"operationId": "tasks.complete",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompleteRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompletionAcknowledgment"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "tasks complete",
"tags": [
"tasks"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/tasks/context — tasks context
Operation: tasks.context
Required capability: task.claim. Current local scoped grants are authoritative.
{
"description": "Required capability: task.claim. Current local scoped grants are authoritative.",
"operationId": "tasks.context",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LeaseProof"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskExecutionContext"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "tasks context",
"tags": [
"tasks"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/tasks/credentials — tasks credentials
Operation: tasks.credentials
Required capability: credential.lease. Current local scoped grants are authoritative.
{
"description": "Required capability: credential.lease. Current local scoped grants are authoritative.",
"operationId": "tasks.credentials",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CredentialRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CredentialResponse"
}
}
},
"description": "Success",
"headers": {
"Cache-Control": {
"required": true,
"schema": {
"const": "no-store",
"type": "string"
}
},
"Pragma": {
"required": true,
"schema": {
"const": "no-cache",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "tasks credentials",
"tags": [
"tasks"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/tasks/fail — tasks fail
Operation: tasks.fail
Required capability: task.complete. Current local scoped grants are authoritative.
{
"description": "Required capability: task.complete. Current local scoped grants are authoritative.",
"operationId": "tasks.fail",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FailRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CompletionAcknowledgment"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "tasks fail",
"tags": [
"tasks"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/tasks/heartbeat — tasks heartbeat
Operation: tasks.heartbeat
Required capability: task.heartbeat. Current local scoped grants are authoritative.
{
"description": "Required capability: task.heartbeat. Current local scoped grants are authoritative.",
"operationId": "tasks.heartbeat",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LeaseProof"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TaskLease"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "tasks heartbeat",
"tags": [
"tasks"
]
}Teams References¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/teams-references — teams_references list
Operation: teams_references.list
Required capability: trigger.manage. Current local scoped grants are authoritative. Teams must be explicitly enabled; otherwise these routes return unavailable (409).
{
"description": "Required capability: trigger.manage. Current local scoped grants are authoritative. Teams must be explicitly enabled; otherwise these routes return unavailable (409).",
"operationId": "teams_references.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_TeamsReference_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "teams_references list",
"tags": [
"teams_references"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/teams-references/{identifier} — teams_references read
Operation: teams_references.read
Required capability: trigger.manage. Current local scoped grants are authoritative. Teams must be explicitly enabled; otherwise these routes return unavailable (409).
{
"description": "Required capability: trigger.manage. Current local scoped grants are authoritative. Teams must be explicitly enabled; otherwise these routes return unavailable (409).",
"operationId": "teams_references.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamsReference"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "teams_references read",
"tags": [
"teams_references"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/teams-references/{identifier}/reactivate — teams_references reactivate
Operation: teams_references.reactivate
Required capability: trigger.manage + connection.manage + connection.bind. Current local scoped grants are authoritative. Teams must be explicitly enabled; otherwise these routes return unavailable (409).
{
"description": "Required capability: trigger.manage + connection.manage + connection.bind. Current local scoped grants are authoritative. Teams must be explicitly enabled; otherwise these routes return unavailable (409).",
"operationId": "teams_references.reactivate",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamsReactivateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamsReference"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "teams_references reactivate",
"tags": [
"teams_references"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/teams-references/{identifier}/revoke — teams_references revoke
Operation: teams_references.revoke
Required capability: trigger.manage + connection.manage + connection.bind. Current local scoped grants are authoritative. Teams must be explicitly enabled; otherwise these routes return unavailable (409).
{
"description": "Required capability: trigger.manage + connection.manage + connection.bind. Current local scoped grants are authoritative. Teams must be explicitly enabled; otherwise these routes return unavailable (409).",
"operationId": "teams_references.revoke",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamsRevokeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamsReference"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "teams_references revoke",
"tags": [
"teams_references"
]
}Triggers¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/triggers — triggers list
Operation: triggers.list
Required capability: trigger.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: trigger.manage. Current local scoped grants are authoritative.",
"operationId": "triggers.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_Trigger_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "triggers list",
"tags": [
"triggers"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/triggers — triggers create
Operation: triggers.create
Required capability: trigger.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: trigger.manage. Current local scoped grants are authoritative.",
"operationId": "triggers.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TriggerRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Trigger"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "triggers create",
"tags": [
"triggers"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/triggers/{identifier} — triggers read
Operation: triggers.read
Required capability: trigger.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: trigger.manage. Current local scoped grants are authoritative.",
"operationId": "triggers.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Trigger"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "triggers read",
"tags": [
"triggers"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/triggers/{identifier}/disable — triggers disable
Operation: triggers.disable
Required capability: trigger.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: trigger.manage. Current local scoped grants are authoritative.",
"operationId": "triggers.disable",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Disabled"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "triggers disable",
"tags": [
"triggers"
]
}Webhooks¶
POST /webhooks/{identifier} — webhooks receive
Operation: webhooks.receive
Required capability: signed webhook and pinned principal authority. Current local scoped grants are authoritative.
{
"description": "Required capability: signed webhook and pinned principal authority. Current local scoped grants are authoritative.",
"operationId": "webhooks.receive",
"parameters": [
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "X-Weave-Signature",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "X-Weave-Timestamp",
"required": true,
"schema": {
"type": "string"
}
},
{
"in": "header",
"name": "X-Weave-Event-ID",
"required": false,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebhookEnvelope"
}
}
},
"required": true
},
"responses": {
"202": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TriggerReceipt"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"webhookSignature": []
}
],
"summary": "webhooks receive",
"tags": [
"webhooks"
]
}Whatsapp Statuses¶
GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/provider-sources/{identifier}/whatsapp-statuses — whatsapp_statuses read
Operation: whatsapp_statuses.read
Required capability: run.read. Current local scoped grants are authoritative.
{
"description": "Required capability: run.read. Current local scoped grants are authoritative.",
"operationId": "whatsapp_statuses.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "message_id",
"required": true,
"schema": {
"$ref": "#/components/schemas/MessageId"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WhatsAppDeliveryState"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "whatsapp_statuses read",
"tags": [
"whatsapp_statuses"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/provider-sources/{identifier}/whatsapp-statuses/{state_id}/facts — whatsapp_statuses facts
Operation: whatsapp_statuses.facts
Required capability: run.read. Current local scoped grants are authoritative.
{
"description": "Required capability: run.read. Current local scoped grants are authoritative.",
"operationId": "whatsapp_statuses.facts",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "state_id",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_WhatsAppStatusFact_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "whatsapp_statuses facts",
"tags": [
"whatsapp_statuses"
]
}Workers¶
POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/worker-connection-grants — workers grant
Operation: workers.grant
Required capability: connection.manage. Current local scoped grants are authoritative.
{
"description": "Required capability: connection.manage. Current local scoped grants are authoritative.",
"operationId": "workers.grant",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CredentialGrantRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Granted"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "workers grant",
"tags": [
"workers"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/workers — workers list
Operation: workers.list
Required capability: status.read. Current local scoped grants are authoritative.
{
"description": "Required capability: status.read. Current local scoped grants are authoritative.",
"operationId": "workers.list",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "query",
"name": "limit",
"required": false,
"schema": {
"$ref": "#/components/schemas/PageLimit",
"default": 50
}
},
{
"in": "query",
"name": "cursor",
"required": false,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Page_WorkerStatus_"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "workers list",
"tags": [
"workers"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/workers — workers create
Operation: workers.create
Required capability: worker.register. Current local scoped grants are authoritative.
{
"description": "Required capability: worker.register. Current local scoped grants are authoritative.",
"operationId": "workers.create",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InstanceRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerInstance"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "workers create",
"tags": [
"workers"
]
}GET /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/workers/{identifier} — workers read
Operation: workers.read
Required capability: status.read. Current local scoped grants are authoritative.
{
"description": "Required capability: status.read. Current local scoped grants are authoritative.",
"operationId": "workers.read",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerStatus"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "workers read",
"tags": [
"workers"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/workers/{identifier}/drain — workers drain
Operation: workers.drain
Required capability: worker.drain. Current local scoped grants are authoritative.
{
"description": "Required capability: worker.drain. Current local scoped grants are authoritative.",
"operationId": "workers.drain",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerControlRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerStatus"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "workers drain",
"tags": [
"workers"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/workers/{identifier}/resume — workers resume
Operation: workers.resume
Required capability: worker.drain. Current local scoped grants are authoritative.
{
"description": "Required capability: worker.drain. Current local scoped grants are authoritative.",
"operationId": "workers.resume",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "header",
"name": "Idempotency-Key",
"required": true,
"schema": {
"maxLength": 200,
"minLength": 1,
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerControlRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkerStatus"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "workers resume",
"tags": [
"workers"
]
}POST /api/v1/tenants/{tenant}/projects/{project}/environments/{environment}/workers/{identifier}/revoke — workers revoke
Operation: workers.revoke
Required capability: release.retire. Current local scoped grants are authoritative.
{
"description": "Required capability: release.retire. Current local scoped grants are authoritative.",
"operationId": "workers.revoke",
"parameters": [
{
"in": "path",
"name": "tenant",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "project",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "environment",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
},
{
"in": "path",
"name": "identifier",
"required": true,
"schema": {
"format": "uuid",
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Revoked"
}
}
},
"description": "Success",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"WWW-Authenticate": {
"schema": {
"const": "Bearer",
"type": "string"
}
},
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"409": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"412": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"413": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"422": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Problem"
}
}
},
"description": "Problem",
"headers": {
"X-Weave-Request-ID": {
"required": true,
"schema": {
"type": "string"
}
},
"X-Weave-Wire-Version": {
"required": true,
"schema": {
"const": "weave/api-v1",
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"summary": "workers revoke",
"tags": [
"workers"
]
}Authentication schemes¶
{
"bearer": {
"bearerFormat": "JWT",
"scheme": "bearer",
"type": "http"
},
"webhookSignature": {
"description": "HMAC signature bound to timestamp, event ID and exact request bytes; replay receipt belongs to one immutable trigger revision.",
"in": "header",
"name": "X-Weave-Signature",
"type": "apiKey"
}
}Schemas¶
ActionDefinition-Input
{
"additionalProperties": false,
"properties": {
"apiVersion": {
"const": "weave/v1alpha1",
"title": "Apiversion",
"type": "string"
},
"kind": {
"const": "Action",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"spec": {
"$ref": "#/components/schemas/ActionSpec-Input"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ActionDefinition",
"type": "object"
}ActionDefinition-Output
{
"additionalProperties": false,
"properties": {
"apiVersion": {
"const": "weave/v1alpha1",
"title": "Apiversion",
"type": "string"
},
"kind": {
"const": "Action",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"spec": {
"$ref": "#/components/schemas/ActionSpec-Output"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ActionDefinition",
"type": "object"
}ActionIR
{
"additionalProperties": false,
"properties": {
"apiVersion": {
"const": "weave/v1alpha1",
"title": "Apiversion",
"type": "string"
},
"dependencies": {
"items": {
"$ref": "#/components/schemas/Dependency"
},
"title": "Dependencies",
"type": "array"
},
"features": {
"items": {
"$ref": "#/components/schemas/LanguageFeature"
},
"title": "Features",
"type": "array",
"uniqueItems": true
},
"guards": {
"items": {
"$ref": "#/components/schemas/Guard"
},
"title": "Guards",
"type": "array"
},
"irVersion": {
"enum": [
"weave/ir-v1alpha1",
"weave/ir-v1alpha2",
"weave/ir-v1alpha3"
],
"title": "Irversion",
"type": "string"
},
"kind": {
"const": "Action",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"schemas": {
"additionalProperties": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"propertyNames": {
"$ref": "#/components/schemas/firefly_weave__compiler__ir__Digest"
},
"title": "Schemas",
"type": "object"
},
"spec": {
"$ref": "#/components/schemas/ActionSpec-Output"
}
},
"required": [
"irVersion",
"apiVersion",
"metadata",
"dependencies",
"schemas",
"guards",
"kind",
"spec"
],
"title": "ActionIR",
"type": "object"
}ActionImplementation-Input
{
"discriminator": {
"mapping": {
"connector": "#/components/schemas/ConnectorImplementation-Input",
"worker": "#/components/schemas/WorkerImplementation"
},
"propertyName": "kind"
},
"oneOf": [
{
"$ref": "#/components/schemas/WorkerImplementation"
},
{
"$ref": "#/components/schemas/ConnectorImplementation-Input"
}
]
}ActionImplementation-Output
{
"discriminator": {
"mapping": {
"connector": "#/components/schemas/ConnectorImplementation-Output",
"worker": "#/components/schemas/WorkerImplementation"
},
"propertyName": "kind"
},
"oneOf": [
{
"$ref": "#/components/schemas/WorkerImplementation"
},
{
"$ref": "#/components/schemas/ConnectorImplementation-Output"
}
]
}ActionNode
{
"additionalProperties": false,
"properties": {
"connection": {
"anyOf": [
{
"$ref": "#/components/schemas/ResourceName"
},
{
"type": "null"
}
]
},
"dependency": {
"$ref": "#/components/schemas/firefly_weave__compiler__ir__Digest"
},
"id": {
"$ref": "#/components/schemas/NodeId"
},
"kind": {
"const": "action",
"title": "Kind",
"type": "string"
},
"llmProfile": {
"anyOf": [
{
"$ref": "#/components/schemas/LLMProfile-Output"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"$ref": "#/components/schemas/JsonPointer"
},
"scope": {
"items": {
"$ref": "#/components/schemas/UnicodeString"
},
"maxItems": 64,
"title": "Scope",
"type": "array"
},
"with": {
"$ref": "#/components/schemas/Expression-Output"
}
},
"required": [
"id",
"scope",
"path",
"kind",
"dependency",
"with",
"connection"
],
"title": "ActionNode",
"type": "object"
}ActionSpec-Input
{
"additionalProperties": false,
"properties": {
"connection": {
"$ref": "#/components/schemas/OmissionOnly_ConnectionRequirement_"
},
"implementation": {
"$ref": "#/components/schemas/ActionImplementation-Input"
},
"inputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"outputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"retry": {
"$ref": "#/components/schemas/RetryPolicy"
},
"routing": {
"$ref": "#/components/schemas/OmissionOnly_WorkerRouting_"
},
"sideEffect": {
"$ref": "#/components/schemas/SideEffect"
},
"timeoutSeconds": {
"$ref": "#/components/schemas/PositiveInt"
}
},
"required": [
"implementation",
"sideEffect",
"timeoutSeconds",
"inputSchema",
"outputSchema"
],
"title": "ActionSpec",
"type": "object"
}ActionSpec-Output
{
"additionalProperties": false,
"properties": {
"connection": {
"$ref": "#/components/schemas/OmissionOnly_ConnectionRequirement_"
},
"implementation": {
"$ref": "#/components/schemas/ActionImplementation-Output"
},
"inputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"outputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"retry": {
"$ref": "#/components/schemas/RetryPolicy"
},
"routing": {
"$ref": "#/components/schemas/OmissionOnly_WorkerRouting_"
},
"sideEffect": {
"$ref": "#/components/schemas/SideEffect"
},
"timeoutSeconds": {
"$ref": "#/components/schemas/PositiveInt"
}
},
"required": [
"implementation",
"sideEffect",
"timeoutSeconds",
"inputSchema",
"outputSchema"
],
"title": "ActionSpec",
"type": "object"
}ActionStep-Input
{
"additionalProperties": false,
"properties": {
"connection": {
"$ref": "#/components/schemas/OmissionOnly_ResourceName_"
},
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "action",
"title": "Kind",
"type": "string"
},
"uses": {
"$ref": "#/components/schemas/VersionedReference"
},
"with": {
"$ref": "#/components/schemas/Expression-Input"
}
},
"required": [
"id",
"kind",
"uses",
"with"
],
"title": "ActionStep",
"type": "object"
}ActionStep-Output
{
"additionalProperties": false,
"properties": {
"connection": {
"$ref": "#/components/schemas/OmissionOnly_ResourceName_"
},
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "action",
"title": "Kind",
"type": "string"
},
"uses": {
"$ref": "#/components/schemas/VersionedReference"
},
"with": {
"$ref": "#/components/schemas/Expression-Output"
}
},
"required": [
"id",
"kind",
"uses",
"with"
],
"title": "ActionStep",
"type": "object"
}Activation
{
"additionalProperties": false,
"properties": {
"assignment_pins": {
"additionalProperties": {
"$ref": "#/components/schemas/AssignmentPin"
},
"propertyNames": {
"$ref": "#/components/schemas/ResourceName"
},
"title": "Assignment Pins",
"type": "object"
},
"connector_execution_pins": {
"items": {
"$ref": "#/components/schemas/ConnectorExecutionPin"
},
"title": "Connector Execution Pins",
"type": "array"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"request": {
"$ref": "#/components/schemas/ActivationRequest"
},
"retired": {
"default": false,
"title": "Retired",
"type": "boolean"
},
"revision": {
"minimum": 1,
"title": "Revision",
"type": "integer"
}
},
"required": [
"id",
"revision",
"name",
"request"
],
"title": "Activation",
"type": "object"
}ActivationExport
{
"additionalProperties": false,
"properties": {
"revisions": {
"items": {
"$ref": "#/components/schemas/Activation"
},
"title": "Revisions",
"type": "array"
}
},
"required": [
"revisions"
],
"title": "ActivationExport",
"type": "object"
}ActivationRequest
{
"additionalProperties": false,
"properties": {
"artifact_digest": {
"$ref": "#/components/schemas/firefly_weave__contracts__catalog__Digest"
},
"assignment_binding_ids": {
"additionalProperties": {
"format": "uuid",
"type": "string"
},
"propertyNames": {
"$ref": "#/components/schemas/ResourceName"
},
"title": "Assignment Binding Ids",
"type": "object"
},
"connection_revision_ids": {
"additionalProperties": {
"format": "uuid",
"type": "string"
},
"propertyNames": {
"$ref": "#/components/schemas/ResourceName"
},
"title": "Connection Revision Ids",
"type": "object"
},
"connector_release_ids": {
"additionalProperties": {
"format": "uuid",
"type": "string"
},
"propertyNames": {
"format": "uuid"
},
"title": "Connector Release Ids",
"type": "object"
},
"scope": {
"$ref": "#/components/schemas/Scope"
},
"version_id": {
"format": "uuid",
"title": "Version Id",
"type": "string"
},
"worker_release_ids": {
"additionalProperties": {
"format": "uuid",
"type": "string"
},
"propertyNames": {
"$ref": "#/components/schemas/ResourceName"
},
"title": "Worker Release Ids",
"type": "object"
}
},
"required": [
"version_id",
"artifact_digest",
"scope"
],
"title": "ActivationRequest",
"type": "object"
}AdapterKind
{
"enum": [
"docker-compose",
"kubernetes",
"azure-container-apps"
],
"type": "string"
}AdapterName
{
"maxLength": 128,
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]{0,127}$",
"type": "string"
}ApplyPlanRequest
{
"additionalProperties": false,
"properties": {
"digest": {
"$ref": "#/components/schemas/firefly_weave__contracts__catalog__Digest"
}
},
"required": [
"digest"
],
"title": "ApplyPlanRequest",
"type": "object"
}Arity
{
"additionalProperties": false,
"properties": {
"max": {
"$ref": "#/components/schemas/OmissionOnly_PositiveInt_"
},
"min": {
"$ref": "#/components/schemas/PositiveInt"
}
},
"required": [
"min"
],
"title": "Arity",
"type": "object"
}ArrayExpression-Input
{
"additionalProperties": false,
"properties": {
"array": {
"items": {
"$ref": "#/components/schemas/Expression-Input"
},
"title": "Array",
"type": "array"
}
},
"required": [
"array"
],
"title": "ArrayExpression",
"type": "object"
}ArrayExpression-Output
{
"additionalProperties": false,
"properties": {
"array": {
"items": {
"$ref": "#/components/schemas/Expression-Output"
},
"title": "Array",
"type": "array"
}
},
"required": [
"array"
],
"title": "ArrayExpression",
"type": "object"
}ArtifactEnvelope
{
"additionalProperties": false,
"properties": {
"diagnostics": {
"items": {
"$ref": "#/components/schemas/Diagnostic"
},
"title": "Diagnostics",
"type": "array"
},
"digest": {
"$ref": "#/components/schemas/firefly_weave__compiler__ir__Digest"
},
"executable": {
"$ref": "#/components/schemas/Executable"
},
"omittedCount": {
"minimum": 0,
"title": "Omittedcount",
"type": "integer"
},
"schemaTruncated": {
"title": "Schematruncated",
"type": "boolean"
},
"sourceHash": {
"$ref": "#/components/schemas/firefly_weave__compiler__ir__Digest"
},
"sourceMap": {
"additionalProperties": {
"$ref": "#/components/schemas/SourceRange"
},
"propertyNames": {
"$ref": "#/components/schemas/JsonPointer"
},
"title": "Sourcemap",
"type": "object"
}
},
"required": [
"executable",
"digest",
"sourceHash",
"sourceMap",
"diagnostics",
"omittedCount",
"schemaTruncated"
],
"title": "ArtifactEnvelope",
"type": "object"
}AssignmentBinding
{
"additionalProperties": false,
"properties": {
"binding_id": {
"format": "uuid",
"title": "Binding Id",
"type": "string"
},
"enabled": {
"title": "Enabled",
"type": "boolean"
},
"group_ids": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 256,
"title": "Group Ids",
"type": "array"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"principal_ids": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 256,
"title": "Principal Ids",
"type": "array"
},
"revision": {
"minimum": 1,
"title": "Revision",
"type": "integer"
}
},
"required": [
"binding_id",
"revision",
"name",
"enabled"
],
"title": "AssignmentBinding",
"type": "object"
}AssignmentBindingList
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/AssignmentBinding"
},
"title": "Items",
"type": "array"
}
},
"required": [
"items"
],
"title": "AssignmentBindingList",
"type": "object"
}AssignmentBindingRequest
{
"additionalProperties": false,
"properties": {
"enabled": {
"default": true,
"title": "Enabled",
"type": "boolean"
},
"expected_revision": {
"default": 0,
"minimum": 0,
"title": "Expected Revision",
"type": "integer"
},
"group_ids": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 256,
"title": "Group Ids",
"type": "array"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"principal_ids": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 256,
"title": "Principal Ids",
"type": "array"
}
},
"required": [
"name"
],
"title": "AssignmentBindingRequest",
"type": "object"
}AssignmentPin
{
"additionalProperties": false,
"properties": {
"binding_id": {
"format": "uuid",
"title": "Binding Id",
"type": "string"
},
"group_ids": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 256,
"title": "Group Ids",
"type": "array"
},
"principal_ids": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 256,
"title": "Principal Ids",
"type": "array"
},
"revision": {
"minimum": 1,
"title": "Revision",
"type": "integer"
}
},
"required": [
"binding_id",
"revision"
],
"title": "AssignmentPin",
"type": "object"
}AttachmentMetadata
{
"additionalProperties": false,
"properties": {
"content_type": {
"title": "Content Type",
"type": "string"
},
"filename": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Filename"
},
"size": {
"title": "Size",
"type": "integer"
}
},
"required": [
"filename",
"content_type",
"size"
],
"title": "AttachmentMetadata",
"type": "object"
}AuxiliaryReceipt
{
"additionalProperties": false,
"properties": {
"accepted_at": {
"format": "date-time",
"title": "Accepted At",
"type": "string"
},
"generation": {
"title": "Generation",
"type": "integer"
},
"receipt_id": {
"format": "uuid",
"title": "Receipt Id",
"type": "string"
},
"status": {
"const": "ignored",
"title": "Status",
"type": "string"
},
"task_id": {
"format": "uuid",
"title": "Task Id",
"type": "string"
}
},
"required": [
"task_id",
"generation",
"receipt_id",
"status",
"accepted_at"
],
"title": "AuxiliaryReceipt",
"type": "object"
}Boundary
{
"additionalProperties": false,
"properties": {
"event_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Event Type"
},
"kind": {
"enum": [
"event",
"node"
],
"title": "Kind",
"type": "string"
},
"node_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Node Id"
},
"node_kind": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Node Kind"
}
},
"required": [
"kind"
],
"title": "Boundary",
"type": "object"
}Branch-Input
{
"additionalProperties": false,
"properties": {
"output": {
"$ref": "#/components/schemas/Expression-Input"
},
"steps": {
"items": {
"$ref": "#/components/schemas/Step-Input"
},
"title": "Steps",
"type": "array"
}
},
"required": [
"steps",
"output"
],
"title": "Branch",
"type": "object"
}Branch-Output
{
"additionalProperties": false,
"properties": {
"output": {
"$ref": "#/components/schemas/Expression-Output"
},
"steps": {
"items": {
"$ref": "#/components/schemas/Step-Output"
},
"title": "Steps",
"type": "array"
}
},
"required": [
"steps",
"output"
],
"title": "Branch",
"type": "object"
}BranchOutputNode
{
"additionalProperties": false,
"properties": {
"branch": {
"$ref": "#/components/schemas/UnicodeString"
},
"completes": {
"title": "Completes",
"type": "boolean"
},
"id": {
"$ref": "#/components/schemas/NodeId"
},
"kind": {
"const": "branch-output",
"title": "Kind",
"type": "string"
},
"output": {
"$ref": "#/components/schemas/Expression-Output"
},
"owner": {
"$ref": "#/components/schemas/NodeId"
},
"path": {
"$ref": "#/components/schemas/JsonPointer"
},
"scope": {
"items": {
"$ref": "#/components/schemas/UnicodeString"
},
"maxItems": 64,
"title": "Scope",
"type": "array"
}
},
"required": [
"id",
"scope",
"path",
"kind",
"owner",
"branch",
"output",
"completes"
],
"title": "BranchOutputNode",
"type": "object"
}BranchState
{
"additionalProperties": false,
"properties": {
"name": {
"title": "Name",
"type": "string"
},
"output": {
"$ref": "#/components/schemas/JsonData-Output",
"default": null
},
"owner": {
"title": "Owner",
"type": "string"
},
"parent": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Parent"
},
"status": {
"default": "pending",
"enum": [
"pending",
"running",
"completed",
"cancelled"
],
"title": "Status",
"type": "string"
},
"steps": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"target": {
"title": "Target",
"type": "string"
},
"visible": {
"$ref": "#/components/schemas/JsonObjectData-Output"
}
},
"required": [
"owner",
"name",
"target"
],
"title": "BranchState",
"type": "object"
}BrokerIncident
{
"additionalProperties": false,
"properties": {
"code": {
"title": "Code",
"type": "string"
},
"evidence": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"receipt_id": {
"format": "uuid",
"title": "Receipt Id",
"type": "string"
},
"trigger_id": {
"format": "uuid",
"title": "Trigger Id",
"type": "string"
}
},
"required": [
"id",
"trigger_id",
"receipt_id",
"code",
"evidence"
],
"title": "BrokerIncident",
"type": "object"
}BrokerTrigger
{
"additionalProperties": false,
"properties": {
"activation_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Activation Id"
},
"binding_id": {
"format": "uuid",
"title": "Binding Id",
"type": "string"
},
"blocked": {
"default": false,
"title": "Blocked",
"type": "boolean"
},
"cluster_id": {
"$ref": "#/components/schemas/ResourceName"
},
"connection_revision_id": {
"format": "uuid",
"title": "Connection Revision Id",
"type": "string"
},
"dead_letter_policy": {
"enum": [
"receipt",
"halt"
],
"title": "Dead Letter Policy",
"type": "string"
},
"disabled": {
"default": false,
"title": "Disabled",
"type": "boolean"
},
"driver": {
"const": "kafka",
"default": "kafka",
"title": "Driver",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"kind": {
"enum": [
"run",
"signal"
],
"title": "Kind",
"type": "string"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"payload_schema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"principal_id": {
"format": "uuid",
"title": "Principal Id",
"type": "string"
},
"run_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Run Id"
},
"signal": {
"anyOf": [
{
"$ref": "#/components/schemas/ResourceName"
},
{
"type": "null"
}
],
"default": null
},
"topic": {
"maxLength": 249,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_-][a-zA-Z0-9._-]*$",
"title": "Topic",
"type": "string"
}
},
"required": [
"name",
"connection_revision_id",
"cluster_id",
"topic",
"kind",
"dead_letter_policy",
"id",
"binding_id",
"principal_id"
],
"title": "BrokerTrigger",
"type": "object"
}BrokerTriggerRequest
{
"additionalProperties": false,
"properties": {
"activation_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Activation Id"
},
"cluster_id": {
"$ref": "#/components/schemas/ResourceName"
},
"connection_revision_id": {
"format": "uuid",
"title": "Connection Revision Id",
"type": "string"
},
"dead_letter_policy": {
"enum": [
"receipt",
"halt"
],
"title": "Dead Letter Policy",
"type": "string"
},
"driver": {
"const": "kafka",
"default": "kafka",
"title": "Driver",
"type": "string"
},
"kind": {
"enum": [
"run",
"signal"
],
"title": "Kind",
"type": "string"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"payload_schema": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"run_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Run Id"
},
"signal": {
"anyOf": [
{
"$ref": "#/components/schemas/ResourceName"
},
{
"type": "null"
}
],
"default": null
},
"topic": {
"maxLength": 249,
"minLength": 1,
"pattern": "^[a-zA-Z0-9_-][a-zA-Z0-9._-]*$",
"title": "Topic",
"type": "string"
}
},
"required": [
"name",
"connection_revision_id",
"cluster_id",
"topic",
"kind",
"dead_letter_policy"
],
"title": "BrokerTriggerRequest",
"type": "object"
}BusinessKey
{
"maxLength": 200,
"type": "string"
}CallWorkflowStep-Input
{
"additionalProperties": false,
"description": "Run an exact published workflow version as a separate child run.",
"properties": {
"businessKey": {
"$ref": "#/components/schemas/OmissionOnly_Expression_-Input"
},
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "callWorkflow",
"title": "Kind",
"type": "string"
},
"mode": {
"default": "wait",
"enum": [
"wait",
"detach"
],
"title": "Mode",
"type": "string"
},
"onFailure": {
"$ref": "#/components/schemas/OmissionOnly_Literal__stop____continue___"
},
"uses": {
"$ref": "#/components/schemas/VersionedReference"
},
"with": {
"$ref": "#/components/schemas/Expression-Input"
}
},
"required": [
"id",
"kind",
"uses",
"with"
],
"title": "CallWorkflowStep",
"type": "object"
}CallWorkflowStep-Output
{
"additionalProperties": false,
"description": "Run an exact published workflow version as a separate child run.",
"properties": {
"businessKey": {
"$ref": "#/components/schemas/OmissionOnly_Expression_-Output"
},
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "callWorkflow",
"title": "Kind",
"type": "string"
},
"mode": {
"default": "wait",
"enum": [
"wait",
"detach"
],
"title": "Mode",
"type": "string"
},
"onFailure": {
"$ref": "#/components/schemas/OmissionOnly_Literal__stop____continue___"
},
"uses": {
"$ref": "#/components/schemas/VersionedReference"
},
"with": {
"$ref": "#/components/schemas/Expression-Output"
}
},
"required": [
"id",
"kind",
"uses",
"with"
],
"title": "CallWorkflowStep",
"type": "object"
}CallableSpec
{
"additionalProperties": false,
"description": "A workflow's opt-in to being called; omitted allowedCallers means any workflow in the project.",
"properties": {
"allowedCallers": {
"$ref": "#/components/schemas/OmissionOnly_CallerNames_"
}
},
"title": "CallableSpec",
"type": "object"
}CallerNames
{
"items": {
"$ref": "#/components/schemas/ResourceName"
},
"maxItems": 100,
"minItems": 1,
"type": "array",
"uniqueItems": true
}CancelRunRequest
{
"additionalProperties": false,
"properties": {
"reason": {
"maxLength": 2000,
"minLength": 1,
"title": "Reason",
"type": "string"
}
},
"required": [
"reason"
],
"title": "CancelRunRequest",
"type": "object"
}CanonicalRevisionTag
{
"pattern": "^\"[1-9][0-9]{0,9}\"$",
"type": "string"
}Capabilities
{
"additionalProperties": false,
"properties": {
"connectors": {
"items": {
"type": "string"
},
"title": "Connectors",
"type": "array"
},
"ir_versions": {
"items": {
"type": "string"
},
"title": "Ir Versions",
"type": "array"
},
"language_versions": {
"items": {
"type": "string"
},
"title": "Language Versions",
"type": "array"
},
"limits": {
"additionalProperties": {
"type": "integer"
},
"title": "Limits",
"type": "object"
},
"operations": {
"anyOf": [
{
"$ref": "#/components/schemas/OperationalCapabilities"
},
{
"type": "null"
}
],
"default": null
},
"schemas": {
"items": {
"type": "string"
},
"title": "Schemas",
"type": "array"
},
"step_kinds": {
"items": {
"type": "string"
},
"title": "Step Kinds",
"type": "array"
},
"wire_version": {
"const": "weave/api-v1",
"default": "weave/api-v1",
"title": "Wire Version",
"type": "string"
}
},
"required": [
"limits",
"schemas",
"connectors"
],
"title": "Capabilities",
"type": "object"
}CapacityRunAcknowledgment
{
"additionalProperties": false,
"properties": {
"accepted_sequence": {
"title": "Accepted Sequence",
"type": "integer"
},
"capacity_limited": {
"const": true,
"default": true,
"title": "Capacity Limited",
"type": "boolean"
},
"external_effects_may_continue": {
"default": true,
"title": "External Effects May Continue",
"type": "boolean"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"omissions": {
"items": {
"$ref": "#/components/schemas/Omission"
},
"title": "Omissions",
"type": "array"
},
"status": {
"enum": [
"cancelled",
"timed_out"
],
"title": "Status",
"type": "string"
}
},
"required": [
"id",
"status",
"accepted_sequence"
],
"title": "CapacityRunAcknowledgment",
"type": "object"
}CatalogLock-Input
{
"additionalProperties": false,
"description": "Published wire shape, with existing catalog identity and digest checks.",
"properties": {
"adapters": {
"items": {
"$ref": "#/components/schemas/ResourceName"
},
"title": "Adapters",
"type": "array"
},
"definitions": {
"items": {
"$ref": "#/components/schemas/CatalogLockDefinition-Input"
},
"title": "Definitions",
"type": "array"
},
"schemas": {
"additionalProperties": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"propertyNames": {
"$ref": "#/components/schemas/UnicodeString"
},
"title": "Schemas",
"type": "object"
},
"tasks": {
"items": {
"$ref": "#/components/schemas/TaskCapability-Input"
},
"title": "Tasks",
"type": "array"
}
},
"required": [
"definitions",
"tasks",
"adapters",
"schemas"
],
"title": "CatalogLock",
"type": "object"
}CatalogLock-Output
{
"additionalProperties": false,
"description": "Published wire shape, with existing catalog identity and digest checks.",
"properties": {
"adapters": {
"items": {
"$ref": "#/components/schemas/ResourceName"
},
"title": "Adapters",
"type": "array"
},
"definitions": {
"items": {
"$ref": "#/components/schemas/CatalogLockDefinition-Output"
},
"title": "Definitions",
"type": "array"
},
"schemas": {
"additionalProperties": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"propertyNames": {
"$ref": "#/components/schemas/UnicodeString"
},
"title": "Schemas",
"type": "object"
},
"tasks": {
"items": {
"$ref": "#/components/schemas/TaskCapability-Output"
},
"title": "Tasks",
"type": "array"
}
},
"required": [
"definitions",
"tasks",
"adapters",
"schemas"
],
"title": "CatalogLock",
"type": "object"
}CatalogLockDefinition-Input
{
"additionalProperties": false,
"properties": {
"digest": {
"allOf": [
{
"$ref": "#/components/schemas/UnicodeString_a-f0-9__64____"
},
{
"pattern": "^[a-f0-9]{64}$",
"type": "string"
}
],
"title": "Digest"
},
"document": {
"$ref": "#/components/schemas/Definition-Input"
}
},
"required": [
"document",
"digest"
],
"title": "CatalogLockDefinition",
"type": "object"
}CatalogLockDefinition-Output
{
"additionalProperties": false,
"properties": {
"digest": {
"allOf": [
{
"$ref": "#/components/schemas/UnicodeString_a-f0-9__64____"
},
{
"pattern": "^[a-f0-9]{64}$",
"type": "string"
}
],
"title": "Digest"
},
"document": {
"$ref": "#/components/schemas/Definition-Output"
}
},
"required": [
"document",
"digest"
],
"title": "CatalogLockDefinition",
"type": "object"
}ClaimRequest
{
"additionalProperties": false,
"properties": {
"limit": {
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"worker_id": {
"format": "uuid",
"title": "Worker Id",
"type": "string"
}
},
"required": [
"worker_id",
"limit"
],
"title": "ClaimRequest",
"type": "object"
}ClientConfiguration
{
"additionalProperties": false,
"description": "Versioned public onboarding document at `/api/v1/client-configuration`.",
"properties": {
"api_version": {
"const": "weave/api-v1",
"default": "weave/api-v1",
"title": "Api Version",
"type": "string"
},
"configuration_version": {
"const": 1,
"default": 1,
"title": "Configuration Version",
"type": "integer"
},
"display_name": {
"anyOf": [
{
"maxLength": 100,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Display Name"
},
"service": {
"const": "firefly-weave",
"default": "firefly-weave",
"title": "Service",
"type": "string"
},
"sign_in": {
"items": {
"$ref": "#/components/schemas/SignInOption"
},
"maxItems": 8,
"title": "Sign In",
"type": "array"
}
},
"title": "ClientConfiguration",
"type": "object"
}CompatibilityAvailability
{
"additionalProperties": false,
"description": "Safe global availability only; findings and inventory remain scoped reports.",
"properties": {
"checked_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Checked At"
},
"complete": {
"default": false,
"title": "Complete",
"type": "boolean"
},
"mode": {
"default": "restricted",
"enum": [
"ready",
"restricted"
],
"title": "Mode",
"type": "string"
},
"ready": {
"default": false,
"title": "Ready",
"type": "boolean"
}
},
"title": "CompatibilityAvailability",
"type": "object"
}CompatibilityFinding
{
"additionalProperties": false,
"properties": {
"code": {
"enum": [
"ir_unsupported",
"artifact_invalid",
"action_unavailable",
"connector_unsupported",
"worker_protocol_unsupported",
"provider_requirement_unsupported",
"inventory_incomplete",
"authority_missing",
"legacy_policy_blocked",
"operational_capacity_blocked",
"capacity_absent",
"policy_mismatch"
],
"title": "Code",
"type": "string"
},
"kind": {
"enum": [
"run",
"activation",
"provider",
"worker",
"connection",
"broker",
"subscription",
"inventory"
],
"title": "Kind",
"type": "string"
},
"resource_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Resource Id"
},
"scope": {
"anyOf": [
{
"$ref": "#/components/schemas/Scope"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"kind",
"code"
],
"title": "CompatibilityFinding",
"type": "object"
}CompatibilityReport
{
"additionalProperties": false,
"properties": {
"checked_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Checked At"
},
"complete": {
"default": false,
"title": "Complete",
"type": "boolean"
},
"findings": {
"items": {
"$ref": "#/components/schemas/CompatibilityFinding"
},
"maxItems": 1000,
"title": "Findings",
"type": "array"
},
"findings_truncated": {
"default": false,
"title": "Findings Truncated",
"type": "boolean"
},
"inspected": {
"default": 0,
"maximum": 100000,
"minimum": 0,
"title": "Inspected",
"type": "integer"
},
"mode": {
"default": "restricted",
"enum": [
"ready",
"restricted"
],
"title": "Mode",
"type": "string"
},
"policy": {
"const": "weave/operations-v1",
"default": "weave/operations-v1",
"title": "Policy",
"type": "string"
}
},
"title": "CompatibilityReport",
"type": "object"
}CompileResponse
{
"additionalProperties": false,
"properties": {
"artifact": {
"anyOf": [
{
"$ref": "#/components/schemas/ArtifactEnvelope"
},
{
"type": "null"
}
]
},
"diagnostics": {
"items": {
"$ref": "#/components/schemas/Diagnostic"
},
"title": "Diagnostics",
"type": "array"
},
"errorCount": {
"minimum": 0,
"title": "Errorcount",
"type": "integer"
},
"ok": {
"title": "Ok",
"type": "boolean"
},
"omittedCount": {
"minimum": 0,
"title": "Omittedcount",
"type": "integer"
},
"partial": {
"title": "Partial",
"type": "boolean"
},
"schemaTruncated": {
"title": "Schematruncated",
"type": "boolean"
},
"truncated": {
"title": "Truncated",
"type": "boolean"
},
"validationOk": {
"title": "Validationok",
"type": "boolean"
}
},
"required": [
"diagnostics",
"artifact",
"partial",
"ok",
"validationOk",
"errorCount",
"omittedCount",
"schemaTruncated",
"truncated"
],
"title": "CompileResponse",
"type": "object"
}CompilerRequest
{
"additionalProperties": false,
"properties": {
"catalog": {
"anyOf": [
{
"$ref": "#/components/schemas/CatalogLock-Input"
},
{
"type": "null"
}
],
"default": null
},
"filename": {
"anyOf": [
{
"maxLength": 4096,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Filename"
},
"format": {
"enum": [
"yaml",
"json",
"object"
],
"title": "Format",
"type": "string"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/JsonObjectData-Input"
}
],
"title": "Source"
},
"strict": {
"default": false,
"title": "Strict",
"type": "boolean"
}
},
"required": [
"source",
"format"
],
"title": "CompilerRequest",
"type": "object"
}CompleteHumanTask
{
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"decision": {
"$ref": "#/components/schemas/ResourceName"
},
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
}
},
"required": [
"expected_revision",
"decision",
"data"
],
"title": "CompleteHumanTask",
"type": "object"
}CompleteRequest
{
"additionalProperties": false,
"properties": {
"completion_id": {
"format": "uuid",
"title": "Completion Id",
"type": "string"
},
"lease": {
"$ref": "#/components/schemas/LeaseProof"
},
"output": {
"$ref": "#/components/schemas/JsonData-Input"
}
},
"required": [
"lease",
"completion_id",
"output"
],
"title": "CompleteRequest",
"type": "object"
}CompletionAcknowledgment
{
"anyOf": [
{
"$ref": "#/components/schemas/CompletionReceipt"
},
{
"$ref": "#/components/schemas/UnavailableCompletionReceipt"
}
]
}CompletionReceipt
{
"additionalProperties": false,
"properties": {
"accepted_at": {
"format": "date-time",
"title": "Accepted At",
"type": "string"
},
"accepted_output_hash": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Accepted Output Hash"
},
"completion_id": {
"format": "uuid",
"title": "Completion Id",
"type": "string"
},
"generation": {
"title": "Generation",
"type": "integer"
},
"reason_code": {
"anyOf": [
{
"enum": [
"WV-SCHEMA-SECRET_VALUE",
"WV-SCHEMA-CLASSIFICATION"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reason Code"
},
"status": {
"enum": [
"completed",
"failed",
"ignored",
"rejected"
],
"title": "Status",
"type": "string"
},
"task_id": {
"format": "uuid",
"title": "Task Id",
"type": "string"
}
},
"required": [
"task_id",
"generation",
"completion_id",
"accepted_output_hash",
"accepted_at",
"status"
],
"title": "CompletionReceipt",
"type": "object"
}ComponentSpec
{
"additionalProperties": false,
"properties": {
"configuration": {
"$ref": "#/components/schemas/DeploymentName"
},
"cpu_millis": {
"default": 500,
"maximum": 16000,
"minimum": 100,
"title": "Cpu Millis",
"type": "integer"
},
"image": {
"$ref": "#/components/schemas/ImageReference"
},
"kind": {
"enum": [
"api",
"worker",
"lumi"
],
"title": "Kind",
"type": "string"
},
"memory_mib": {
"default": 1024,
"maximum": 65536,
"minimum": 128,
"title": "Memory Mib",
"type": "integer"
},
"name": {
"$ref": "#/components/schemas/DeploymentName"
},
"replicas": {
"default": 1,
"maximum": 100,
"minimum": 0,
"title": "Replicas",
"type": "integer"
},
"worker_release_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Worker Release Id"
}
},
"required": [
"name",
"kind",
"image",
"configuration"
],
"title": "ComponentSpec",
"type": "object"
}ConnectionRequest
{
"additionalProperties": false,
"properties": {
"allowed_destinations": {
"default": [],
"items": {
"type": "string"
},
"title": "Allowed Destinations",
"type": "array"
},
"config": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"connector_version_id": {
"format": "uuid",
"title": "Connector Version Id",
"type": "string"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"secretRef": {
"additionalProperties": {
"$ref": "#/components/schemas/ResourceName"
},
"propertyNames": {
"$ref": "#/components/schemas/ResourceName"
},
"title": "Secretref",
"type": "object"
}
},
"required": [
"name",
"connector_version_id"
],
"title": "ConnectionRequest",
"type": "object"
}ConnectionRequirement
{
"additionalProperties": false,
"properties": {
"connector": {
"$ref": "#/components/schemas/VersionedReference"
},
"required": {
"default": true,
"title": "Required",
"type": "boolean"
}
},
"required": [
"connector"
],
"title": "ConnectionRequirement",
"type": "object"
}ConnectionRevision
{
"additionalProperties": false,
"properties": {
"adapter": {
"title": "Adapter",
"type": "string"
},
"allowed_destinations": {
"default": [],
"items": {
"type": "string"
},
"title": "Allowed Destinations",
"type": "array"
},
"config": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"connector": {
"title": "Connector",
"type": "string"
},
"connector_digest": {
"title": "Connector Digest",
"type": "string"
},
"connector_version_id": {
"format": "uuid",
"title": "Connector Version Id",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"revision": {
"title": "Revision",
"type": "integer"
},
"secretRef": {
"additionalProperties": {
"$ref": "#/components/schemas/ResourceName"
},
"propertyNames": {
"$ref": "#/components/schemas/ResourceName"
},
"title": "Secretref",
"type": "object"
}
},
"required": [
"name",
"connector_version_id",
"id",
"revision",
"connector",
"connector_digest",
"adapter"
],
"title": "ConnectionRevision",
"type": "object"
}ConnectionTestResult
{
"additionalProperties": false,
"properties": {
"code": {
"default": "ok",
"enum": [
"ok",
"failed"
],
"title": "Code",
"type": "string"
},
"encrypted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Encrypted"
},
"job_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Job Id"
},
"ok": {
"title": "Ok",
"type": "boolean"
}
},
"required": [
"ok"
],
"title": "ConnectionTestResult",
"type": "object"
}ConnectorAction-Input
{
"additionalProperties": false,
"properties": {
"configSchema": {
"$ref": "#/components/schemas/OmissionOnly_JsonObjectData_-Input"
},
"inputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"outputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"retry": {
"$ref": "#/components/schemas/RetryPolicy"
},
"sideEffect": {
"$ref": "#/components/schemas/SideEffect"
},
"timeoutSeconds": {
"$ref": "#/components/schemas/PositiveInt"
}
},
"required": [
"inputSchema",
"outputSchema",
"sideEffect",
"timeoutSeconds"
],
"title": "ConnectorAction",
"type": "object"
}ConnectorAction-Output
{
"additionalProperties": false,
"properties": {
"configSchema": {
"$ref": "#/components/schemas/OmissionOnly_JsonObjectData_-Output"
},
"inputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"outputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"retry": {
"$ref": "#/components/schemas/RetryPolicy"
},
"sideEffect": {
"$ref": "#/components/schemas/SideEffect"
},
"timeoutSeconds": {
"$ref": "#/components/schemas/PositiveInt"
}
},
"required": [
"inputSchema",
"outputSchema",
"sideEffect",
"timeoutSeconds"
],
"title": "ConnectorAction",
"type": "object"
}ConnectorActionView
{
"additionalProperties": false,
"properties": {
"config_schema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"input_schema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"output_schema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"side_effect": {
"$ref": "#/components/schemas/SideEffect"
},
"timeout_seconds": {
"$ref": "#/components/schemas/PositiveInt"
}
},
"required": [
"name",
"config_schema",
"input_schema",
"output_schema",
"side_effect",
"timeout_seconds"
],
"title": "ConnectorActionView",
"type": "object"
}ConnectorBinding
{
"additionalProperties": false,
"properties": {
"action": {
"$ref": "#/components/schemas/ResourceName"
},
"adapter": {
"$ref": "#/components/schemas/ResourceName"
},
"connector_digest": {
"pattern": "^[a-f0-9]{64}$",
"title": "Connector Digest",
"type": "string"
},
"implementation_version": {
"$ref": "#/components/schemas/SemVer"
},
"task_reference": {
"title": "Task Reference",
"type": "string"
}
},
"required": [
"connector_digest",
"action",
"adapter",
"implementation_version",
"task_reference"
],
"title": "ConnectorBinding",
"type": "object"
}ConnectorCompatibility
{
"additionalProperties": false,
"properties": {
"apiVersion": {
"const": "weave/v1alpha1",
"title": "Apiversion",
"type": "string"
}
},
"required": [
"apiVersion"
],
"title": "ConnectorCompatibility",
"type": "object"
}ConnectorConnectionView
{
"additionalProperties": false,
"properties": {
"auth_schema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"config_schema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
}
},
"required": [
"config_schema",
"auth_schema"
],
"title": "ConnectorConnectionView",
"type": "object"
}ConnectorDefinition-Input
{
"additionalProperties": false,
"properties": {
"apiVersion": {
"const": "weave/v1alpha1",
"title": "Apiversion",
"type": "string"
},
"kind": {
"const": "Connector",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"spec": {
"$ref": "#/components/schemas/ConnectorSpec-Input"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ConnectorDefinition",
"type": "object"
}ConnectorDefinition-Output
{
"additionalProperties": false,
"properties": {
"apiVersion": {
"const": "weave/v1alpha1",
"title": "Apiversion",
"type": "string"
},
"kind": {
"const": "Connector",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"spec": {
"$ref": "#/components/schemas/ConnectorSpec-Output"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "ConnectorDefinition",
"type": "object"
}ConnectorDescriptorView
{
"additionalProperties": false,
"description": "One installed adapter; ``source`` is the exact publication source for ``definitions.publish``.",
"properties": {
"actions": {
"items": {
"$ref": "#/components/schemas/ConnectorActionView"
},
"title": "Actions",
"type": "array"
},
"adapter": {
"$ref": "#/components/schemas/ResourceName"
},
"bindings": {
"items": {
"$ref": "#/components/schemas/ConnectorBinding"
},
"title": "Bindings",
"type": "array"
},
"capabilities": {
"items": {
"$ref": "#/components/schemas/TaskCapability-Output"
},
"title": "Capabilities",
"type": "array"
},
"connection": {
"$ref": "#/components/schemas/ConnectorConnectionView"
},
"digest": {
"pattern": "^[a-f0-9]{64}$",
"title": "Digest",
"type": "string"
},
"implementation_version": {
"$ref": "#/components/schemas/SemVer"
},
"manifest": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"published_version_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Published Version Id"
},
"reference": {
"$ref": "#/components/schemas/VersionedReference"
},
"source": {
"title": "Source",
"type": "string"
}
},
"required": [
"adapter",
"reference",
"digest",
"manifest",
"source",
"implementation_version",
"capabilities",
"bindings",
"actions",
"connection"
],
"title": "ConnectorDescriptorView",
"type": "object"
}ConnectorExecutionPin
{
"additionalProperties": false,
"properties": {
"action": {
"$ref": "#/components/schemas/ResourceName"
},
"action_digest": {
"title": "Action Digest",
"type": "string"
},
"adapter": {
"$ref": "#/components/schemas/ResourceName"
},
"capability_digest": {
"title": "Capability Digest",
"type": "string"
},
"connector_digest": {
"pattern": "^[a-f0-9]{64}$",
"title": "Connector Digest",
"type": "string"
},
"connector_version_id": {
"format": "uuid",
"title": "Connector Version Id",
"type": "string"
},
"implementation_version": {
"$ref": "#/components/schemas/SemVer"
},
"release_id": {
"format": "uuid",
"title": "Release Id",
"type": "string"
},
"task_reference": {
"title": "Task Reference",
"type": "string"
},
"task_type": {
"$ref": "#/components/schemas/ResourceName"
},
"task_version": {
"$ref": "#/components/schemas/SemVer"
}
},
"required": [
"connector_digest",
"action",
"adapter",
"implementation_version",
"task_reference",
"action_digest",
"connector_version_id",
"release_id",
"capability_digest",
"task_type",
"task_version"
],
"title": "ConnectorExecutionPin",
"type": "object"
}ConnectorIR
{
"additionalProperties": false,
"properties": {
"apiVersion": {
"const": "weave/v1alpha1",
"title": "Apiversion",
"type": "string"
},
"dependencies": {
"items": {
"$ref": "#/components/schemas/Dependency"
},
"title": "Dependencies",
"type": "array"
},
"features": {
"items": {
"$ref": "#/components/schemas/LanguageFeature"
},
"title": "Features",
"type": "array",
"uniqueItems": true
},
"guards": {
"items": {
"$ref": "#/components/schemas/Guard"
},
"title": "Guards",
"type": "array"
},
"irVersion": {
"enum": [
"weave/ir-v1alpha1",
"weave/ir-v1alpha2",
"weave/ir-v1alpha3"
],
"title": "Irversion",
"type": "string"
},
"kind": {
"const": "Connector",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"schemas": {
"additionalProperties": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"propertyNames": {
"$ref": "#/components/schemas/firefly_weave__compiler__ir__Digest"
},
"title": "Schemas",
"type": "object"
},
"spec": {
"$ref": "#/components/schemas/ConnectorSpec-Output"
}
},
"required": [
"irVersion",
"apiVersion",
"metadata",
"dependencies",
"schemas",
"guards",
"kind",
"spec"
],
"title": "ConnectorIR",
"type": "object"
}ConnectorImplementation-Input
{
"additionalProperties": false,
"properties": {
"action": {
"$ref": "#/components/schemas/ResourceName"
},
"config": {
"$ref": "#/components/schemas/OmissionOnly_JsonObjectData_-Input"
},
"kind": {
"const": "connector",
"title": "Kind",
"type": "string"
},
"uses": {
"$ref": "#/components/schemas/VersionedReference"
}
},
"required": [
"kind",
"uses",
"action"
],
"title": "ConnectorImplementation",
"type": "object"
}ConnectorImplementation-Output
{
"additionalProperties": false,
"properties": {
"action": {
"$ref": "#/components/schemas/ResourceName"
},
"config": {
"$ref": "#/components/schemas/OmissionOnly_JsonObjectData_-Output"
},
"kind": {
"const": "connector",
"title": "Kind",
"type": "string"
},
"uses": {
"$ref": "#/components/schemas/VersionedReference"
}
},
"required": [
"kind",
"uses",
"action"
],
"title": "ConnectorImplementation",
"type": "object"
}ConnectorLimits
{
"additionalProperties": false,
"description": "Published adapter I/O bounds, distinct from compiler operator budgets.",
"properties": {
"maxRequestBytes": {
"$ref": "#/components/schemas/PositiveInt"
},
"maxResponseBytes": {
"$ref": "#/components/schemas/PositiveInt"
},
"maxTimeoutSeconds": {
"$ref": "#/components/schemas/PositiveInt"
}
},
"required": [
"maxRequestBytes",
"maxResponseBytes",
"maxTimeoutSeconds"
],
"title": "ConnectorLimits",
"type": "object"
}ConnectorSpec-Input
{
"additionalProperties": false,
"properties": {
"actions": {
"additionalProperties": {
"$ref": "#/components/schemas/ConnectorAction-Input"
},
"minProperties": 1,
"propertyNames": {
"$ref": "#/components/schemas/ResourceName"
},
"title": "Actions",
"type": "object"
},
"adapter": {
"$ref": "#/components/schemas/ResourceName"
},
"authSchema": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"compatibility": {
"$ref": "#/components/schemas/ConnectorCompatibility"
},
"configSchema": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"limits": {
"$ref": "#/components/schemas/ConnectorLimits"
}
},
"required": [
"adapter",
"configSchema",
"authSchema",
"actions",
"compatibility",
"limits"
],
"title": "ConnectorSpec",
"type": "object"
}ConnectorSpec-Output
{
"additionalProperties": false,
"properties": {
"actions": {
"additionalProperties": {
"$ref": "#/components/schemas/ConnectorAction-Output"
},
"minProperties": 1,
"propertyNames": {
"$ref": "#/components/schemas/ResourceName"
},
"title": "Actions",
"type": "object"
},
"adapter": {
"$ref": "#/components/schemas/ResourceName"
},
"authSchema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"compatibility": {
"$ref": "#/components/schemas/ConnectorCompatibility"
},
"configSchema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"limits": {
"$ref": "#/components/schemas/ConnectorLimits"
}
},
"required": [
"adapter",
"configSchema",
"authSchema",
"actions",
"compatibility",
"limits"
],
"title": "ConnectorSpec",
"type": "object"
}Count
{
"minimum": 0,
"type": "integer"
}CredentialGrantRequest
{
"additionalProperties": false,
"properties": {
"capability": {
"title": "Capability",
"type": "string"
},
"connection_revision_id": {
"format": "uuid",
"title": "Connection Revision Id",
"type": "string"
},
"release_id": {
"format": "uuid",
"title": "Release Id",
"type": "string"
}
},
"required": [
"release_id",
"connection_revision_id",
"capability"
],
"title": "CredentialGrantRequest",
"type": "object"
}CredentialRequest
{
"additionalProperties": false,
"properties": {
"connection_revision_id": {
"format": "uuid",
"title": "Connection Revision Id",
"type": "string"
},
"lease": {
"$ref": "#/components/schemas/LeaseProof"
},
"slot": {
"maxLength": 100,
"minLength": 1,
"title": "Slot",
"type": "string"
}
},
"required": [
"lease",
"connection_revision_id",
"slot"
],
"title": "CredentialRequest",
"type": "object"
}CredentialResponse
{
"additionalProperties": false,
"properties": {
"expires_at": {
"format": "date-time",
"title": "Expires At",
"type": "string"
},
"provider_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Provider Version"
},
"value": {
"title": "Value",
"type": "string"
}
},
"required": [
"value",
"expires_at"
],
"title": "CredentialResponse",
"type": "object"
}Cursor
{
"maxLength": 2048,
"minLength": 1,
"pattern": "^[A-Za-z0-9_-]+$",
"type": "string"
}DebugCapabilities
{
"additionalProperties": false,
"description": "Fixed session ceilings; creator counts are within a project, not cross-project.",
"properties": {
"lifetime_seconds": {
"exclusiveMinimum": 0,
"title": "Lifetime Seconds",
"type": "integer"
},
"session_bytes": {
"exclusiveMinimum": 0,
"title": "Session Bytes",
"type": "integer"
},
"session_reservation_bytes": {
"exclusiveMinimum": 0,
"title": "Session Reservation Bytes",
"type": "integer"
},
"sessions_per_creator": {
"exclusiveMinimum": 0,
"title": "Sessions Per Creator",
"type": "integer"
},
"sessions_per_project": {
"exclusiveMinimum": 0,
"title": "Sessions Per Project",
"type": "integer"
}
},
"required": [
"session_bytes",
"lifetime_seconds",
"sessions_per_creator",
"sessions_per_project",
"session_reservation_bytes"
],
"title": "DebugCapabilities",
"type": "object"
}DebugCommand
{
"additionalProperties": false,
"properties": {
"kind": {
"enum": [
"next",
"continue",
"signal",
"human_decision",
"advance_time",
"breakpoints"
],
"title": "Kind",
"type": "string"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"node_ids": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"title": "Node Ids"
},
"payload": {
"$ref": "#/components/schemas/JsonData-Input",
"default": null
},
"seconds": {
"anyOf": [
{
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Seconds"
}
},
"required": [
"kind"
],
"title": "DebugCommand",
"type": "object"
}DebugCreate
{
"additionalProperties": false,
"properties": {
"artifact": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"input": {
"$ref": "#/components/schemas/JsonData-Input",
"default": null
},
"mocks": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"now": {
"format": "date-time",
"title": "Now",
"type": "string"
}
},
"required": [
"artifact",
"now"
],
"title": "DebugCreate",
"type": "object"
}DebugSession
{
"additionalProperties": false,
"properties": {
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"expires_at": {
"format": "date-time",
"title": "Expires At",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"revision": {
"title": "Revision",
"type": "integer"
},
"view": {
"$ref": "#/components/schemas/DebugView"
}
},
"required": [
"id",
"revision",
"created_at",
"expires_at",
"view"
],
"title": "DebugSession",
"type": "object"
}DebugView
{
"additionalProperties": false,
"properties": {
"active_nodes": {
"items": {
"type": "string"
},
"title": "Active Nodes",
"type": "array"
},
"boundaries": {
"items": {
"$ref": "#/components/schemas/Boundary"
},
"title": "Boundaries",
"type": "array"
},
"boundary": {
"anyOf": [
{
"$ref": "#/components/schemas/Boundary"
},
{
"type": "null"
}
]
},
"current_nodes": {
"items": {
"type": "string"
},
"title": "Current Nodes",
"type": "array"
},
"diagnostics": {
"items": {
"$ref": "#/components/schemas/Diagnostic"
},
"title": "Diagnostics",
"type": "array"
},
"events": {
"items": {
"$ref": "#/components/schemas/RuntimeEvent"
},
"title": "Events",
"type": "array"
},
"now": {
"format": "date-time",
"title": "Now",
"type": "string"
},
"selected_node": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Selected Node"
},
"status": {
"title": "Status",
"type": "string"
},
"variables": {
"$ref": "#/components/schemas/JsonObjectData-Output"
}
},
"required": [
"status",
"selected_node",
"current_nodes",
"active_nodes",
"variables",
"diagnostics",
"events",
"boundary",
"boundaries",
"now"
],
"title": "DebugView",
"type": "object"
}DecisionEvaluation
{
"additionalProperties": false,
"properties": {
"matched_rule_ids": {
"items": {
"type": "string"
},
"maxItems": 1000,
"title": "Matched Rule Ids",
"type": "array"
},
"output": {
"$ref": "#/components/schemas/JsonData-Output"
},
"used_default": {
"title": "Used Default",
"type": "boolean"
}
},
"required": [
"output",
"matched_rule_ids",
"used_default"
],
"title": "DecisionEvaluation",
"type": "object"
}DecisionEvaluationRequest
{
"additionalProperties": false,
"properties": {
"catalog": {
"anyOf": [
{
"$ref": "#/components/schemas/CatalogLock-Input"
},
{
"type": "null"
}
],
"default": null
},
"filename": {
"anyOf": [
{
"maxLength": 4096,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Filename"
},
"format": {
"enum": [
"yaml",
"json",
"object"
],
"title": "Format",
"type": "string"
},
"input": {
"$ref": "#/components/schemas/JsonData-Input"
},
"source": {
"anyOf": [
{
"type": "string"
},
{
"$ref": "#/components/schemas/JsonObjectData-Input"
}
],
"title": "Source"
},
"strict": {
"default": false,
"title": "Strict",
"type": "boolean"
}
},
"required": [
"source",
"format",
"input"
],
"title": "DecisionEvaluationRequest",
"type": "object"
}DecisionRule-Input
{
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"output": {
"$ref": "#/components/schemas/Expression-Input"
},
"when": {
"$ref": "#/components/schemas/Expression-Input"
}
},
"required": [
"id",
"when",
"output"
],
"title": "DecisionRule",
"type": "object"
}DecisionRule-Output
{
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"output": {
"$ref": "#/components/schemas/Expression-Output"
},
"when": {
"$ref": "#/components/schemas/Expression-Output"
}
},
"required": [
"id",
"when",
"output"
],
"title": "DecisionRule",
"type": "object"
}DecisionTableDefinition-Input
{
"additionalProperties": false,
"properties": {
"apiVersion": {
"const": "weave/v1alpha1",
"title": "Apiversion",
"type": "string"
},
"kind": {
"const": "DecisionTable",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"spec": {
"$ref": "#/components/schemas/DecisionTableSpec-Input"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "DecisionTableDefinition",
"type": "object"
}DecisionTableDefinition-Output
{
"additionalProperties": false,
"properties": {
"apiVersion": {
"const": "weave/v1alpha1",
"title": "Apiversion",
"type": "string"
},
"kind": {
"const": "DecisionTable",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"spec": {
"$ref": "#/components/schemas/DecisionTableSpec-Output"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "DecisionTableDefinition",
"type": "object"
}DecisionTableIR
{
"additionalProperties": false,
"properties": {
"apiVersion": {
"const": "weave/v1alpha1",
"title": "Apiversion",
"type": "string"
},
"dependencies": {
"items": {
"$ref": "#/components/schemas/Dependency"
},
"title": "Dependencies",
"type": "array"
},
"features": {
"items": {
"$ref": "#/components/schemas/LanguageFeature"
},
"title": "Features",
"type": "array",
"uniqueItems": true
},
"guards": {
"items": {
"$ref": "#/components/schemas/Guard"
},
"title": "Guards",
"type": "array"
},
"irVersion": {
"enum": [
"weave/ir-v1alpha1",
"weave/ir-v1alpha2",
"weave/ir-v1alpha3"
],
"title": "Irversion",
"type": "string"
},
"kind": {
"const": "DecisionTable",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"schemas": {
"additionalProperties": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"propertyNames": {
"$ref": "#/components/schemas/firefly_weave__compiler__ir__Digest"
},
"title": "Schemas",
"type": "object"
},
"spec": {
"$ref": "#/components/schemas/DecisionTableSpec-Output"
}
},
"required": [
"irVersion",
"apiVersion",
"metadata",
"dependencies",
"schemas",
"guards",
"kind",
"spec"
],
"title": "DecisionTableIR",
"type": "object"
}DecisionTableNode
{
"additionalProperties": false,
"properties": {
"dependency": {
"$ref": "#/components/schemas/firefly_weave__compiler__ir__Digest"
},
"id": {
"$ref": "#/components/schemas/NodeId"
},
"kind": {
"const": "decisionTable",
"title": "Kind",
"type": "string"
},
"path": {
"$ref": "#/components/schemas/JsonPointer"
},
"scope": {
"items": {
"$ref": "#/components/schemas/UnicodeString"
},
"maxItems": 64,
"title": "Scope",
"type": "array"
},
"with": {
"$ref": "#/components/schemas/Expression-Output"
}
},
"required": [
"id",
"scope",
"path",
"kind",
"dependency",
"with"
],
"title": "DecisionTableNode",
"type": "object"
}DecisionTableSpec-Input
{
"additionalProperties": false,
"properties": {
"defaultOutput": {
"$ref": "#/components/schemas/OmissionOnly_Expression_-Input"
},
"hitPolicy": {
"enum": [
"first",
"unique",
"collect"
],
"title": "Hitpolicy",
"type": "string"
},
"inputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"outputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"rules": {
"items": {
"$ref": "#/components/schemas/DecisionRule-Input"
},
"maxItems": 1000,
"minItems": 1,
"title": "Rules",
"type": "array"
}
},
"required": [
"inputSchema",
"outputSchema",
"hitPolicy",
"rules"
],
"title": "DecisionTableSpec",
"type": "object"
}DecisionTableSpec-Output
{
"additionalProperties": false,
"properties": {
"defaultOutput": {
"$ref": "#/components/schemas/OmissionOnly_Expression_-Output"
},
"hitPolicy": {
"enum": [
"first",
"unique",
"collect"
],
"title": "Hitpolicy",
"type": "string"
},
"inputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"outputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"rules": {
"items": {
"$ref": "#/components/schemas/DecisionRule-Output"
},
"maxItems": 1000,
"minItems": 1,
"title": "Rules",
"type": "array"
}
},
"required": [
"inputSchema",
"outputSchema",
"hitPolicy",
"rules"
],
"title": "DecisionTableSpec",
"type": "object"
}DecisionTableStep-Input
{
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "decisionTable",
"title": "Kind",
"type": "string"
},
"uses": {
"$ref": "#/components/schemas/VersionedReference"
},
"with": {
"$ref": "#/components/schemas/Expression-Input"
}
},
"required": [
"id",
"kind",
"uses",
"with"
],
"title": "DecisionTableStep",
"type": "object"
}DecisionTableStep-Output
{
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "decisionTable",
"title": "Kind",
"type": "string"
},
"uses": {
"$ref": "#/components/schemas/VersionedReference"
},
"with": {
"$ref": "#/components/schemas/Expression-Output"
}
},
"required": [
"id",
"kind",
"uses",
"with"
],
"title": "DecisionTableStep",
"type": "object"
}Definition-Input
{
"discriminator": {
"mapping": {
"Action": "#/components/schemas/ActionDefinition-Input",
"Connector": "#/components/schemas/ConnectorDefinition-Input",
"DecisionTable": "#/components/schemas/DecisionTableDefinition-Input",
"Workflow": "#/components/schemas/WorkflowDefinition-Input"
},
"propertyName": "kind"
},
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowDefinition-Input"
},
{
"$ref": "#/components/schemas/ActionDefinition-Input"
},
{
"$ref": "#/components/schemas/ConnectorDefinition-Input"
},
{
"$ref": "#/components/schemas/DecisionTableDefinition-Input"
}
]
}Definition-Output
{
"discriminator": {
"mapping": {
"Action": "#/components/schemas/ActionDefinition-Output",
"Connector": "#/components/schemas/ConnectorDefinition-Output",
"DecisionTable": "#/components/schemas/DecisionTableDefinition-Output",
"Workflow": "#/components/schemas/WorkflowDefinition-Output"
},
"propertyName": "kind"
},
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowDefinition-Output"
},
{
"$ref": "#/components/schemas/ActionDefinition-Output"
},
{
"$ref": "#/components/schemas/ConnectorDefinition-Output"
},
{
"$ref": "#/components/schemas/DecisionTableDefinition-Output"
}
]
}DefinitionKind
{
"enum": [
"Workflow",
"Action",
"Connector",
"DecisionTable"
],
"type": "string"
}DeliveryAttempt
{
"additionalProperties": false,
"properties": {
"finished_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Finished At"
},
"generation": {
"title": "Generation",
"type": "integer"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"outcome": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Outcome"
},
"provider_version": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Provider Version"
},
"started_at": {
"format": "date-time",
"title": "Started At",
"type": "string"
}
},
"required": [
"id",
"generation",
"started_at",
"finished_at",
"outcome",
"provider_version"
],
"title": "DeliveryAttempt",
"type": "object"
}DeliveryView
{
"additionalProperties": false,
"properties": {
"attempt_limit": {
"title": "Attempt Limit",
"type": "integer"
},
"attempts": {
"title": "Attempts",
"type": "integer"
},
"code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Code"
},
"event_id": {
"format": "uuid",
"title": "Event Id",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"status": {
"enum": [
"pending",
"leased",
"retry",
"delivered",
"incident"
],
"title": "Status",
"type": "string"
},
"subscription_id": {
"format": "uuid",
"title": "Subscription Id",
"type": "string"
}
},
"required": [
"id",
"event_id",
"subscription_id",
"status",
"attempts",
"attempt_limit"
],
"title": "DeliveryView",
"type": "object"
}Dependency
{
"additionalProperties": false,
"properties": {
"digest": {
"$ref": "#/components/schemas/firefly_weave__compiler__ir__Digest"
},
"document": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"kind": {
"enum": [
"Workflow",
"Action",
"Connector",
"DecisionTable",
"TaskCapability",
"Adapter",
"Schema"
],
"title": "Kind",
"type": "string"
},
"reference": {
"$ref": "#/components/schemas/UnicodeString"
}
},
"required": [
"kind",
"reference",
"digest",
"document"
],
"title": "Dependency",
"type": "object"
}Deployment
{
"additionalProperties": false,
"properties": {
"components": {
"items": {
"$ref": "#/components/schemas/ComponentSpec"
},
"maxItems": 100,
"minItems": 1,
"title": "Components",
"type": "array"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"name": {
"$ref": "#/components/schemas/DeploymentName"
},
"ownership": {
"default": "imported",
"enum": [
"imported",
"managed"
],
"title": "Ownership",
"type": "string"
},
"revision": {
"minimum": 1,
"title": "Revision",
"type": "integer"
},
"scope": {
"$ref": "#/components/schemas/Scope"
},
"target_id": {
"format": "uuid",
"title": "Target Id",
"type": "string"
}
},
"required": [
"target_id",
"name",
"components",
"id",
"scope",
"revision",
"created_at"
],
"title": "Deployment",
"type": "object"
}DeploymentCapability
{
"enum": [
"observe",
"deploy",
"update",
"scale_workers",
"drain_workers"
],
"type": "string"
}DeploymentJob
{
"additionalProperties": false,
"properties": {
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"deadline": {
"format": "date-time",
"title": "Deadline",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"kind": {
"enum": [
"observe",
"apply"
],
"title": "Kind",
"type": "string"
},
"observation_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Observation Id"
},
"operation_key": {
"format": "uuid",
"title": "Operation Key",
"type": "string"
},
"plan_digest": {
"anyOf": [
{
"$ref": "#/components/schemas/firefly_weave__contracts__catalog__Digest"
},
{
"type": "null"
}
],
"default": null
},
"plan_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Plan Id"
},
"receipt": {
"anyOf": [
{
"$ref": "#/components/schemas/SafeDeploymentReceipt"
},
{
"type": "null"
}
],
"default": null
},
"reconciliation_started_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reconciliation Started At"
},
"revision": {
"minimum": 1,
"title": "Revision",
"type": "integer"
},
"scope": {
"$ref": "#/components/schemas/Scope"
},
"state": {
"$ref": "#/components/schemas/JobState"
},
"target_id": {
"format": "uuid",
"title": "Target Id",
"type": "string"
},
"target_revision": {
"minimum": 1,
"title": "Target Revision",
"type": "integer"
}
},
"required": [
"id",
"scope",
"target_id",
"target_revision",
"kind",
"state",
"revision",
"operation_key",
"created_at",
"deadline"
],
"title": "DeploymentJob",
"type": "object"
}DeploymentLease
{
"additionalProperties": false,
"properties": {
"deployment": {
"anyOf": [
{
"$ref": "#/components/schemas/Deployment"
},
{
"type": "null"
}
],
"default": null
},
"expires_at": {
"format": "date-time",
"title": "Expires At",
"type": "string"
},
"job": {
"$ref": "#/components/schemas/DeploymentJob"
},
"observation": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentObservation"
},
{
"type": "null"
}
],
"default": null
},
"plan": {
"anyOf": [
{
"$ref": "#/components/schemas/DeploymentPlan"
},
{
"type": "null"
}
],
"default": null
},
"proof": {
"$ref": "#/components/schemas/DeploymentLeaseProof"
},
"target": {
"$ref": "#/components/schemas/DeploymentTarget"
}
},
"required": [
"proof",
"expires_at",
"job",
"target"
],
"title": "DeploymentLease",
"type": "object"
}DeploymentLeaseProof
{
"additionalProperties": false,
"properties": {
"generation": {
"minimum": 1,
"title": "Generation",
"type": "integer"
},
"job_id": {
"format": "uuid",
"title": "Job Id",
"type": "string"
},
"runner_id": {
"format": "uuid",
"title": "Runner Id",
"type": "string"
},
"token": {
"format": "uuid",
"title": "Token",
"type": "string"
}
},
"required": [
"job_id",
"runner_id",
"generation",
"token"
],
"title": "DeploymentLeaseProof",
"type": "object"
}DeploymentName
{
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]{0,99}$",
"type": "string"
}DeploymentObservation
{
"additionalProperties": false,
"properties": {
"complete": {
"title": "Complete",
"type": "boolean"
},
"digest": {
"$ref": "#/components/schemas/firefly_weave__contracts__catalog__Digest"
},
"expires_at": {
"format": "date-time",
"title": "Expires At",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"observed_at": {
"format": "date-time",
"title": "Observed At",
"type": "string"
},
"resources": {
"items": {
"$ref": "#/components/schemas/ObservedResource"
},
"maxItems": 100,
"title": "Resources",
"type": "array"
},
"settled": {
"default": false,
"title": "Settled",
"type": "boolean"
},
"target_id": {
"format": "uuid",
"title": "Target Id",
"type": "string"
},
"target_revision": {
"minimum": 1,
"title": "Target Revision",
"type": "integer"
}
},
"required": [
"resources",
"complete",
"id",
"target_id",
"target_revision",
"observed_at",
"expires_at",
"digest"
],
"title": "DeploymentObservation",
"type": "object"
}DeploymentPlan
{
"additionalProperties": false,
"properties": {
"adapter": {
"$ref": "#/components/schemas/AdapterKind"
},
"adapter_version": {
"const": "1",
"default": "1",
"title": "Adapter Version",
"type": "string"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"deployment_id": {
"format": "uuid",
"title": "Deployment Id",
"type": "string"
},
"deployment_revision": {
"minimum": 1,
"title": "Deployment Revision",
"type": "integer"
},
"digest": {
"$ref": "#/components/schemas/firefly_weave__contracts__catalog__Digest"
},
"expires_at": {
"format": "date-time",
"title": "Expires At",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"intent": {
"enum": [
"deploy",
"update",
"scale_workers",
"drain_workers"
],
"title": "Intent",
"type": "string"
},
"observation_digest": {
"$ref": "#/components/schemas/firefly_weave__contracts__catalog__Digest"
},
"observation_id": {
"format": "uuid",
"title": "Observation Id",
"type": "string"
},
"risks": {
"items": {
"enum": [
"service_interruption",
"external_effects",
"adoption",
"worker_drain"
],
"type": "string"
},
"maxItems": 4,
"title": "Risks",
"type": "array"
},
"scope": {
"$ref": "#/components/schemas/Scope"
},
"steps": {
"items": {
"$ref": "#/components/schemas/PlanStep"
},
"maxItems": 100,
"minItems": 1,
"title": "Steps",
"type": "array"
},
"target_id": {
"format": "uuid",
"title": "Target Id",
"type": "string"
},
"target_revision": {
"minimum": 1,
"title": "Target Revision",
"type": "integer"
}
},
"required": [
"id",
"scope",
"target_id",
"target_revision",
"deployment_id",
"deployment_revision",
"adapter",
"intent",
"observation_id",
"observation_digest",
"steps",
"risks",
"created_at",
"expires_at",
"digest"
],
"title": "DeploymentPlan",
"type": "object"
}DeploymentRequest
{
"additionalProperties": false,
"properties": {
"components": {
"items": {
"$ref": "#/components/schemas/ComponentSpec"
},
"maxItems": 100,
"minItems": 1,
"title": "Components",
"type": "array"
},
"name": {
"$ref": "#/components/schemas/DeploymentName"
},
"ownership": {
"default": "imported",
"enum": [
"imported",
"managed"
],
"title": "Ownership",
"type": "string"
},
"target_id": {
"format": "uuid",
"title": "Target Id",
"type": "string"
}
},
"required": [
"target_id",
"name",
"components"
],
"title": "DeploymentRequest",
"type": "object"
}DeploymentRunner
{
"additionalProperties": false,
"properties": {
"adapter": {
"$ref": "#/components/schemas/AdapterKind"
},
"adapter_version": {
"const": "1",
"default": "1",
"title": "Adapter Version",
"type": "string"
},
"capabilities": {
"items": {
"$ref": "#/components/schemas/DeploymentCapability"
},
"maxItems": 5,
"minItems": 1,
"title": "Capabilities",
"type": "array"
},
"expires_at": {
"format": "date-time",
"title": "Expires At",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"last_seen": {
"format": "date-time",
"title": "Last Seen",
"type": "string"
},
"principal_id": {
"format": "uuid",
"title": "Principal Id",
"type": "string"
},
"revoked": {
"default": false,
"title": "Revoked",
"type": "boolean"
},
"target_id": {
"format": "uuid",
"title": "Target Id",
"type": "string"
}
},
"required": [
"target_id",
"adapter",
"capabilities",
"id",
"principal_id",
"last_seen",
"expires_at"
],
"title": "DeploymentRunner",
"type": "object"
}DeploymentTarget
{
"additionalProperties": false,
"properties": {
"adapter": {
"$ref": "#/components/schemas/AdapterKind"
},
"boundary": {
"$ref": "#/components/schemas/DeploymentName"
},
"capabilities": {
"items": {
"$ref": "#/components/schemas/DeploymentCapability"
},
"maxItems": 5,
"minItems": 1,
"title": "Capabilities",
"type": "array"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"disabled": {
"default": false,
"title": "Disabled",
"type": "boolean"
},
"external_identity": {
"$ref": "#/components/schemas/ExternalIdentity"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"name": {
"$ref": "#/components/schemas/DeploymentName"
},
"revision": {
"minimum": 1,
"title": "Revision",
"type": "integer"
},
"runner_principal_id": {
"format": "uuid",
"title": "Runner Principal Id",
"type": "string"
},
"scope": {
"$ref": "#/components/schemas/Scope"
}
},
"required": [
"name",
"adapter",
"external_identity",
"boundary",
"runner_principal_id",
"capabilities",
"id",
"scope",
"revision",
"created_at"
],
"title": "DeploymentTarget",
"type": "object"
}DetailLimit
{
"maximum": 500,
"minimum": 1,
"type": "integer"
}Diagnostic
{
"additionalProperties": false,
"properties": {
"code": {
"allOf": [
{
"$ref": "#/components/schemas/UnicodeString_A-Z0-9_____A-Z0-9________"
},
{
"pattern": "^WV-[A-Z0-9]+(?:-[A-Z0-9_]+)+$",
"type": "string"
}
],
"title": "Code"
},
"hint": {
"anyOf": [
{
"$ref": "#/components/schemas/UnicodeString"
},
{
"type": "null"
}
],
"default": null
},
"message": {
"$ref": "#/components/schemas/UnicodeString",
"minLength": 1
},
"path": {
"$ref": "#/components/schemas/JsonPointer"
},
"related": {
"items": {
"$ref": "#/components/schemas/RelatedLocation"
},
"title": "Related",
"type": "array"
},
"severity": {
"enum": [
"error",
"warning",
"info"
],
"title": "Severity",
"type": "string"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/SourceRange"
},
{
"type": "null"
}
],
"default": null
},
"stage": {
"enum": [
"parse",
"schema",
"resolution",
"semantic",
"lowering",
"evaluation"
],
"title": "Stage",
"type": "string"
},
"suggestedEdit": {
"anyOf": [
{
"$ref": "#/components/schemas/SuggestedEdit"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"code",
"severity",
"stage",
"message",
"path"
],
"title": "Diagnostic",
"type": "object"
}Disabled
{
"additionalProperties": false,
"properties": {
"disabled": {
"const": true,
"default": true,
"title": "Disabled",
"type": "boolean"
}
},
"title": "Disabled",
"type": "object"
}DistributionVersion
{
"allOf": [
{
"$ref": "#/components/schemas/UnicodeString_A-Za-z0-9_____-__0_127____"
},
{
"pattern": "^[A-Za-z0-9][A-Za-z0-9.!+_-]{0,127}$",
"type": "string"
}
]
}Draft
{
"additionalProperties": false,
"properties": {
"document": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"revision": {
"minimum": 1,
"title": "Revision",
"type": "integer"
}
},
"required": [
"id",
"revision",
"document"
],
"title": "Draft",
"type": "object"
}DraftExport
{
"additionalProperties": false,
"properties": {
"revisions": {
"items": {
"$ref": "#/components/schemas/DraftView"
},
"title": "Revisions",
"type": "array"
}
},
"required": [
"revisions"
],
"title": "DraftExport",
"type": "object"
}DraftRequest
{
"additionalProperties": false,
"properties": {
"document": {
"$ref": "#/components/schemas/JsonObjectData-Input"
}
},
"required": [
"document"
],
"title": "DraftRequest",
"type": "object"
}DraftRetirement
{
"additionalProperties": false,
"properties": {
"document_revision": {
"minimum": 1,
"title": "Document Revision",
"type": "integer"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"retired": {
"const": true,
"default": true,
"title": "Retired",
"type": "boolean"
},
"revision": {
"minimum": 2,
"title": "Revision",
"type": "integer"
}
},
"required": [
"id",
"revision",
"document_revision"
],
"title": "DraftRetirement",
"type": "object"
}DraftView
{
"additionalProperties": false,
"properties": {
"document": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"retired": {
"default": false,
"title": "Retired",
"type": "boolean"
},
"retirement_revision": {
"anyOf": [
{
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Retirement Revision"
},
"revision": {
"minimum": 1,
"title": "Revision",
"type": "integer"
}
},
"required": [
"id",
"revision",
"document"
],
"title": "DraftView",
"type": "object"
}EmailAttachment
{
"additionalProperties": false,
"properties": {
"content_base64": {
"maxLength": 1400000,
"title": "Content Base64",
"type": "string"
},
"content_type": {
"pattern": "^[a-zA-Z0-9.+-]+/[a-zA-Z0-9.+-]+$",
"title": "Content Type",
"type": "string"
},
"filename": {
"maxLength": 200,
"minLength": 1,
"title": "Filename",
"type": "string"
}
},
"required": [
"filename",
"content_type",
"content_base64"
],
"title": "EmailAttachment",
"type": "object"
}EmailConversation
{
"additionalProperties": false,
"properties": {
"connection_revision_id": {
"format": "uuid",
"title": "Connection Revision Id",
"type": "string"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"run_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Run Id"
},
"subject": {
"title": "Subject",
"type": "string"
}
},
"required": [
"id",
"connection_revision_id",
"subject",
"created_at"
],
"title": "EmailConversation",
"type": "object"
}EmailConversationDetail
{
"additionalProperties": false,
"properties": {
"conversation": {
"$ref": "#/components/schemas/EmailConversation"
},
"messages": {
"items": {
"$ref": "#/components/schemas/EmailMessage"
},
"title": "Messages",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"conversation",
"messages"
],
"title": "EmailConversationDetail",
"type": "object"
}EmailCorrelationRequest
{
"additionalProperties": false,
"properties": {
"conversation_id": {
"format": "uuid",
"title": "Conversation Id",
"type": "string"
},
"run_id": {
"format": "uuid",
"title": "Run Id",
"type": "string"
},
"signal": {
"maxLength": 128,
"minLength": 1,
"pattern": "^[A-Za-z][A-Za-z0-9_.-]*$",
"title": "Signal",
"type": "string"
}
},
"required": [
"conversation_id",
"run_id",
"signal"
],
"title": "EmailCorrelationRequest",
"type": "object"
}EmailCorrelationToken
{
"additionalProperties": false,
"properties": {
"expires_at": {
"format": "date-time",
"title": "Expires At",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"reply_address": {
"title": "Reply Address",
"type": "string"
}
},
"required": [
"id",
"reply_address",
"expires_at"
],
"title": "EmailCorrelationToken",
"type": "object"
}EmailMessage
{
"additionalProperties": false,
"properties": {
"accepted_at": {
"format": "date-time",
"title": "Accepted At",
"type": "string"
},
"conversation_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Conversation Id"
},
"direction": {
"enum": [
"inbound",
"outbound"
],
"title": "Direction",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"mail": {
"$ref": "#/components/schemas/NormalizedEmail"
},
"state": {
"title": "State",
"type": "string"
}
},
"required": [
"id",
"conversation_id",
"direction",
"state",
"accepted_at",
"mail"
],
"title": "EmailMessage",
"type": "object"
}EmailReceipt
{
"additionalProperties": false,
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"message": {
"anyOf": [
{
"$ref": "#/components/schemas/EmailMessage"
},
{
"type": "null"
}
],
"default": null
},
"message_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Message Id"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reason"
},
"run_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Run Id"
},
"signal_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Signal Id"
},
"source_id": {
"format": "uuid",
"title": "Source Id",
"type": "string"
},
"state": {
"title": "State",
"type": "string"
},
"transport_key": {
"title": "Transport Key",
"type": "string"
}
},
"required": [
"id",
"source_id",
"transport_key",
"message_id",
"state"
],
"title": "EmailReceipt",
"type": "object"
}EmailReplyRequest
{
"additionalProperties": false,
"properties": {
"attachments": {
"default": [],
"items": {
"$ref": "#/components/schemas/EmailAttachment"
},
"maxItems": 10,
"title": "Attachments",
"type": "array"
},
"connection_revision_id": {
"format": "uuid",
"title": "Connection Revision Id",
"type": "string"
},
"html": {
"anyOf": [
{
"maxLength": 1048576,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Html"
},
"parent_message_id": {
"format": "uuid",
"title": "Parent Message Id",
"type": "string"
},
"reply_all": {
"default": false,
"title": "Reply All",
"type": "boolean"
},
"request_id": {
"format": "uuid",
"title": "Request Id",
"type": "string"
},
"text": {
"maxLength": 1048576,
"title": "Text",
"type": "string"
}
},
"required": [
"request_id",
"connection_revision_id",
"parent_message_id",
"text"
],
"title": "EmailReplyRequest",
"type": "object"
}EmailSendRequest
{
"additionalProperties": false,
"properties": {
"attachments": {
"default": [],
"items": {
"$ref": "#/components/schemas/EmailAttachment"
},
"maxItems": 10,
"title": "Attachments",
"type": "array"
},
"bcc": {
"default": [],
"items": {
"type": "string"
},
"maxItems": 50,
"title": "Bcc",
"type": "array"
},
"cc": {
"default": [],
"items": {
"type": "string"
},
"maxItems": 50,
"title": "Cc",
"type": "array"
},
"connection_revision_id": {
"format": "uuid",
"title": "Connection Revision Id",
"type": "string"
},
"html": {
"anyOf": [
{
"maxLength": 1048576,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Html"
},
"request_id": {
"format": "uuid",
"title": "Request Id",
"type": "string"
},
"subject": {
"maxLength": 998,
"title": "Subject",
"type": "string"
},
"text": {
"maxLength": 1048576,
"title": "Text",
"type": "string"
},
"to": {
"items": {
"type": "string"
},
"maxItems": 50,
"minItems": 1,
"title": "To",
"type": "array"
}
},
"required": [
"request_id",
"connection_revision_id",
"to",
"subject",
"text"
],
"title": "EmailSendRequest",
"type": "object"
}EmailSourceRequest
{
"additionalProperties": false,
"properties": {
"activation_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Activation Id"
},
"connection_revision_id": {
"format": "uuid",
"title": "Connection Revision Id",
"type": "string"
}
},
"required": [
"connection_revision_id"
],
"title": "EmailSourceRequest",
"type": "object"
}EmailSourceResult
{
"additionalProperties": false,
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
}
},
"required": [
"id"
],
"title": "EmailSourceResult",
"type": "object"
}EmailSourceStatus
{
"additionalProperties": false,
"properties": {
"admitted": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Admitted"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reason"
},
"run_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Run Id"
},
"state": {
"title": "State",
"type": "string"
},
"uid": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Uid"
}
},
"required": [
"state"
],
"title": "EmailSourceStatus",
"type": "object"
}EmailSubmission
{
"additionalProperties": false,
"properties": {
"accepted_recipients": {
"default": [],
"items": {
"type": "string"
},
"title": "Accepted Recipients",
"type": "array"
},
"conversation_id": {
"format": "uuid",
"title": "Conversation Id",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"message_id": {
"format": "uuid",
"title": "Message Id",
"type": "string"
},
"rejected_recipients": {
"default": [],
"items": {
"type": "string"
},
"title": "Rejected Recipients",
"type": "array"
},
"state": {
"enum": [
"queued",
"attempting",
"accepted",
"rejected",
"unknown"
],
"title": "State",
"type": "string"
}
},
"required": [
"id",
"conversation_id",
"message_id",
"state"
],
"title": "EmailSubmission",
"type": "object"
}EmailTokenRequest
{
"additionalProperties": false,
"properties": {
"conversation_id": {
"format": "uuid",
"title": "Conversation Id",
"type": "string"
},
"run_id": {
"format": "uuid",
"title": "Run Id",
"type": "string"
},
"signal": {
"maxLength": 128,
"minLength": 1,
"pattern": "^[A-Za-z][A-Za-z0-9_.-]*$",
"title": "Signal",
"type": "string"
},
"source_id": {
"format": "uuid",
"title": "Source Id",
"type": "string"
},
"validity_seconds": {
"default": 86400,
"maximum": 604800,
"minimum": 1,
"title": "Validity Seconds",
"type": "integer"
}
},
"required": [
"source_id",
"conversation_id",
"run_id",
"signal"
],
"title": "EmailTokenRequest",
"type": "object"
}EndNode
{
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/NodeId"
},
"kind": {
"const": "end",
"title": "Kind",
"type": "string"
},
"output": {
"$ref": "#/components/schemas/Expression-Output"
},
"path": {
"$ref": "#/components/schemas/JsonPointer"
},
"scope": {
"items": {
"$ref": "#/components/schemas/UnicodeString"
},
"maxItems": 64,
"title": "Scope",
"type": "array"
}
},
"required": [
"id",
"scope",
"path",
"kind",
"output"
],
"title": "EndNode",
"type": "object"
}ErrorCode
{
"maxLength": 100,
"minLength": 1,
"type": "string"
}EventIdentity
{
"maxLength": 256,
"minLength": 1,
"type": "string"
}EventPage
{
"additionalProperties": false,
"properties": {
"events": {
"items": {
"$ref": "#/components/schemas/RuntimeEvent"
},
"title": "Events",
"type": "array"
},
"high_water_sequence": {
"minimum": 0,
"title": "High Water Sequence",
"type": "integer"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
},
"run_id": {
"format": "uuid",
"title": "Run Id",
"type": "string"
},
"scope": {
"$ref": "#/components/schemas/Scope"
}
},
"required": [
"run_id",
"scope",
"high_water_sequence",
"events"
],
"title": "EventPage",
"type": "object"
}Executable
{
"discriminator": {
"mapping": {
"Action": "#/components/schemas/ActionIR",
"Connector": "#/components/schemas/ConnectorIR",
"DecisionTable": "#/components/schemas/DecisionTableIR",
"Workflow": "#/components/schemas/WorkflowIR"
},
"propertyName": "kind"
},
"oneOf": [
{
"$ref": "#/components/schemas/WorkflowIR"
},
{
"$ref": "#/components/schemas/ActionIR"
},
{
"$ref": "#/components/schemas/ConnectorIR"
},
{
"$ref": "#/components/schemas/DecisionTableIR"
}
]
}Expression-Input
{
"oneOf": [
{
"$ref": "#/components/schemas/LiteralExpression-Input"
},
{
"$ref": "#/components/schemas/RefExpression"
},
{
"$ref": "#/components/schemas/ObjectExpression-Input"
},
{
"$ref": "#/components/schemas/ArrayExpression-Input"
},
{
"$ref": "#/components/schemas/OpExpression-Input"
}
]
}Expression-Output
{
"oneOf": [
{
"$ref": "#/components/schemas/LiteralExpression-Output"
},
{
"$ref": "#/components/schemas/RefExpression"
},
{
"$ref": "#/components/schemas/ObjectExpression-Output"
},
{
"$ref": "#/components/schemas/ArrayExpression-Output"
},
{
"$ref": "#/components/schemas/OpExpression-Output"
}
]
}ExternalIdentity
{
"maxLength": 512,
"minLength": 1,
"pattern": "^[a-zA-Z0-9/][a-zA-Z0-9_./:@-]*$",
"type": "string"
}FailNode
{
"additionalProperties": false,
"properties": {
"code": {
"$ref": "#/components/schemas/ResourceName"
},
"id": {
"$ref": "#/components/schemas/NodeId"
},
"kind": {
"const": "fail",
"title": "Kind",
"type": "string"
},
"message": {
"$ref": "#/components/schemas/UnicodeString",
"minLength": 1
},
"path": {
"$ref": "#/components/schemas/JsonPointer"
},
"scope": {
"items": {
"$ref": "#/components/schemas/UnicodeString"
},
"maxItems": 64,
"title": "Scope",
"type": "array"
}
},
"required": [
"id",
"scope",
"path",
"kind",
"code",
"message"
],
"title": "FailNode",
"type": "object"
}FailRequest
{
"additionalProperties": false,
"properties": {
"error": {
"$ref": "#/components/schemas/TaskError"
},
"lease": {
"$ref": "#/components/schemas/LeaseProof"
}
},
"required": [
"lease",
"error"
],
"title": "FailRequest",
"type": "object"
}FailStep
{
"additionalProperties": false,
"properties": {
"code": {
"$ref": "#/components/schemas/ResourceName"
},
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "fail",
"title": "Kind",
"type": "string"
},
"message": {
"$ref": "#/components/schemas/UnicodeString",
"minLength": 1
}
},
"required": [
"id",
"kind",
"code",
"message"
],
"title": "FailStep",
"type": "object"
}FailedStep
{
"additionalProperties": false,
"properties": {
"error_code": {
"anyOf": [
{
"$ref": "#/components/schemas/ErrorCode"
},
{
"type": "null"
}
]
},
"instance_key": {
"maxLength": 512,
"pattern": "^(?:@?[A-Za-z0-9][A-Za-z0-9_.:@-]*(?:\\[(?:0|[1-9][0-9]{0,14}|[1-8][0-9]{15}|900[0-6][0-9]{12}|90070[0-9]{11}|90071[0-8][0-9]{10}|900719[0-8][0-9]{9}|9007199[0-1][0-9]{8}|90071992[0-4][0-9]{7}|900719925[0-3][0-9]{6}|9007199254[0-6][0-9]{5}|90071992547[0-3][0-9]{4}|9007199254740[0-8][0-9]{2}|90071992547409[0-8][0-9]|9007199254740990|9007199254740991)\\])*(?:#[A-Za-z0-9]+(?:\\.[A-Za-z0-9]+)*)?(?:~(?:[1-9][0-9]{0,14}|[1-8][0-9]{15}|900[0-6][0-9]{12}|90070[0-9]{11}|90071[0-8][0-9]{10}|900719[0-8][0-9]{9}|9007199[0-1][0-9]{8}|90071992[0-4][0-9]{7}|900719925[0-3][0-9]{6}|9007199254[0-6][0-9]{5}|90071992547[0-3][0-9]{4}|9007199254740[0-8][0-9]{2}|90071992547409[0-8][0-9]|9007199254740990|9007199254740991))?)?$",
"title": "Instance Key",
"type": "string"
},
"node_id": {
"$ref": "#/components/schemas/ResourceName"
}
},
"required": [
"node_id",
"instance_key",
"error_code"
],
"title": "FailedStep",
"type": "object"
}FileChunk
{
"additionalProperties": false,
"properties": {
"contentBase64": {
"maxLength": 349528,
"title": "Contentbase64",
"type": "string"
},
"index": {
"maximum": 99,
"minimum": 0,
"title": "Index",
"type": "integer"
}
},
"required": [
"index",
"contentBase64"
],
"title": "FileChunk",
"type": "object"
}FileChunkRead
{
"additionalProperties": false,
"properties": {
"index": {
"maximum": 99,
"minimum": 0,
"title": "Index",
"type": "integer"
}
},
"required": [
"index"
],
"title": "FileChunkRead",
"type": "object"
}FileCommand
{
"additionalProperties": false,
"properties": {},
"title": "FileCommand",
"type": "object"
}FileCreate
{
"additionalProperties": false,
"properties": {
"contentType": {
"maxLength": 128,
"pattern": "^[a-zA-Z0-9!#$&^_.+-]+/[a-zA-Z0-9!#$&^_.+-]+$",
"title": "Contenttype",
"type": "string"
},
"filename": {
"maxLength": 255,
"minLength": 1,
"title": "Filename",
"type": "string"
},
"sha256": {
"pattern": "^[0-9a-f]{64}$",
"title": "Sha256",
"type": "string"
},
"sizeBytes": {
"maximum": 26214400,
"minimum": 0,
"title": "Sizebytes",
"type": "integer"
}
},
"required": [
"filename",
"contentType",
"sizeBytes",
"sha256"
],
"title": "FileCreate",
"type": "object"
}FileReference
{
"additionalProperties": false,
"properties": {
"contentType": {
"maxLength": 128,
"pattern": "^[a-zA-Z0-9!#$&^_.+-]+/[a-zA-Z0-9!#$&^_.+-]+$",
"title": "Contenttype",
"type": "string"
},
"filename": {
"maxLength": 255,
"minLength": 1,
"title": "Filename",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"kind": {
"const": "weave/file",
"default": "weave/file",
"title": "Kind",
"type": "string"
},
"sha256": {
"pattern": "^[0-9a-f]{64}$",
"title": "Sha256",
"type": "string"
},
"sizeBytes": {
"maximum": 26214400,
"minimum": 0,
"title": "Sizebytes",
"type": "integer"
}
},
"required": [
"filename",
"contentType",
"sizeBytes",
"sha256",
"id"
],
"title": "FileReference",
"type": "object"
}FileUpload
{
"additionalProperties": false,
"properties": {
"chunk_bytes": {
"const": 262144,
"default": 262144,
"title": "Chunk Bytes",
"type": "integer"
},
"file": {
"$ref": "#/components/schemas/FileReference"
},
"received_chunks": {
"items": {
"type": "integer"
},
"maxItems": 100,
"title": "Received Chunks",
"type": "array"
},
"state": {
"enum": [
"uploading",
"ready",
"deleted"
],
"title": "State",
"type": "string"
}
},
"required": [
"file",
"state"
],
"title": "FileUpload",
"type": "object"
}FiniteFloat
{
"type": "number"
}ForEachStep-Input
{
"additionalProperties": false,
"description": "Run ``body`` once per element of ``items`` and collect one result per element, in element order.",
"properties": {
"body": {
"$ref": "#/components/schemas/Branch-Input"
},
"collect": {
"default": "all",
"enum": [
"all",
"nonNull"
],
"title": "Collect",
"type": "string"
},
"concurrency": {
"$ref": "#/components/schemas/PositiveInt",
"default": 1
},
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"items": {
"$ref": "#/components/schemas/Expression-Input"
},
"kind": {
"const": "forEach",
"title": "Kind",
"type": "string"
},
"maxItems": {
"$ref": "#/components/schemas/PositiveInt",
"default": 1000
}
},
"required": [
"id",
"kind",
"items",
"body"
],
"title": "ForEachStep",
"type": "object"
}ForEachStep-Output
{
"additionalProperties": false,
"description": "Run ``body`` once per element of ``items`` and collect one result per element, in element order.",
"properties": {
"body": {
"$ref": "#/components/schemas/Branch-Output"
},
"collect": {
"default": "all",
"enum": [
"all",
"nonNull"
],
"title": "Collect",
"type": "string"
},
"concurrency": {
"$ref": "#/components/schemas/PositiveInt",
"default": 1
},
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"items": {
"$ref": "#/components/schemas/Expression-Output"
},
"kind": {
"const": "forEach",
"title": "Kind",
"type": "string"
},
"maxItems": {
"$ref": "#/components/schemas/PositiveInt",
"default": 1000
}
},
"required": [
"id",
"kind",
"items",
"body"
],
"title": "ForEachStep",
"type": "object"
}ForkBranch
{
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/components/schemas/UnicodeString"
},
"target": {
"$ref": "#/components/schemas/NodeId"
}
},
"required": [
"name",
"target"
],
"title": "ForkBranch",
"type": "object"
}Grant
{
"additionalProperties": false,
"properties": {
"resources": {
"default": [],
"items": {
"type": "string"
},
"title": "Resources",
"type": "array"
},
"role": {
"enum": [
"platform_admin",
"tenant_admin",
"developer",
"deployer",
"operator",
"viewer",
"worker",
"task_participant",
"task_manager",
"email_reader",
"email_sender",
"email_manager",
"execution_manager",
"lumi_user",
"lumi_manager",
"file_reader",
"file_manager",
"deployment_reader",
"deployment_planner",
"deployment_approver",
"deployment_operator",
"deployment_runner",
"worker_operator"
],
"title": "Role",
"type": "string"
},
"scope": {
"anyOf": [
{
"$ref": "#/components/schemas/Scope"
},
{
"type": "null"
}
]
}
},
"required": [
"role",
"scope"
],
"title": "Grant",
"type": "object"
}GrantRequest
{
"additionalProperties": false,
"properties": {
"grant": {
"$ref": "#/components/schemas/Grant"
},
"principal_id": {
"format": "uuid",
"title": "Principal Id",
"type": "string"
}
},
"required": [
"principal_id",
"grant"
],
"title": "GrantRequest",
"type": "object"
}Granted
{
"additionalProperties": false,
"properties": {
"granted": {
"const": true,
"default": true,
"title": "Granted",
"type": "boolean"
}
},
"title": "Granted",
"type": "object"
}Guard
{
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/components/schemas/JsonPointer"
},
"purpose": {
"enum": [
"compatibility",
"reference_presence",
"operator_operands",
"transform_output",
"action_input",
"action_output",
"decision_input",
"decision_output",
"signal_payload",
"human_output",
"branch_output",
"workflow_input",
"workflow_output"
],
"title": "Purpose",
"type": "string"
},
"schemaRef": {
"$ref": "#/components/schemas/firefly_weave__compiler__ir__Digest"
}
},
"required": [
"path",
"purpose",
"schemaRef"
],
"title": "Guard",
"type": "object"
}Health
{
"additionalProperties": false,
"properties": {
"status": {
"title": "Status",
"type": "string"
}
},
"required": [
"status"
],
"title": "Health",
"type": "object"
}HistoryExport
{
"additionalProperties": false,
"properties": {
"artifact_digest": {
"anyOf": [
{
"$ref": "#/components/schemas/firefly_weave__contracts__catalog__Digest"
},
{
"type": "null"
}
]
},
"auxiliary_complete": {
"title": "Auxiliary Complete",
"type": "boolean"
},
"auxiliary_high_water": {
"format": "date-time",
"title": "Auxiliary High Water",
"type": "string"
},
"auxiliary_receipts": {
"items": {
"$ref": "#/components/schemas/AuxiliaryReceipt"
},
"title": "Auxiliary Receipts",
"type": "array"
},
"bounded_prefix": {
"title": "Bounded Prefix",
"type": "boolean"
},
"events": {
"items": {
"$ref": "#/components/schemas/RuntimeEvent"
},
"title": "Events",
"type": "array"
},
"high_water_sequence": {
"title": "High Water Sequence",
"type": "integer"
},
"node_paths": {
"additionalProperties": {
"type": "string"
},
"title": "Node Paths",
"type": "object"
},
"omissions": {
"items": {
"$ref": "#/components/schemas/Omission"
},
"title": "Omissions",
"type": "array"
},
"replay": {
"$ref": "#/components/schemas/ReplayReport"
},
"run_id": {
"format": "uuid",
"title": "Run Id",
"type": "string"
},
"scope": {
"$ref": "#/components/schemas/Scope"
},
"source_map": {
"additionalProperties": {
"$ref": "#/components/schemas/SourceRange"
},
"title": "Source Map",
"type": "object"
},
"source_reference": {
"anyOf": [
{
"$ref": "#/components/schemas/SourceReference"
},
{
"type": "null"
}
],
"default": null
},
"version": {
"const": "weave/history-v1",
"default": "weave/history-v1",
"title": "Version",
"type": "string"
}
},
"required": [
"run_id",
"scope",
"artifact_digest",
"events",
"high_water_sequence",
"bounded_prefix",
"auxiliary_complete",
"auxiliary_high_water",
"replay"
],
"title": "HistoryExport",
"type": "object"
}HumanFileChunk
{
"additionalProperties": false,
"properties": {
"chunk": {
"$ref": "#/components/schemas/FileChunk"
},
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
},
"file_id": {
"format": "uuid",
"title": "File Id",
"type": "string"
}
},
"required": [
"expected_revision",
"file_id",
"chunk"
],
"title": "HumanFileChunk",
"type": "object"
}HumanFileCommand
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
},
"file_id": {
"format": "uuid",
"title": "File Id",
"type": "string"
}
},
"required": [
"expected_revision",
"file_id"
],
"title": "HumanFileCommand",
"type": "object"
}HumanFileCreate
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
},
"file": {
"$ref": "#/components/schemas/FileCreate"
}
},
"required": [
"expected_revision",
"file"
],
"title": "HumanFileCreate",
"type": "object"
}HumanFileRead
{
"additionalProperties": false,
"properties": {
"chunk": {
"$ref": "#/components/schemas/FileChunkRead"
},
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
},
"file_id": {
"format": "uuid",
"title": "File Id",
"type": "string"
}
},
"required": [
"expected_revision",
"file_id",
"chunk"
],
"title": "HumanFileRead",
"type": "object"
}HumanTask
{
"additionalProperties": false,
"properties": {
"assignment": {
"$ref": "#/components/schemas/AssignmentPin"
},
"claimant_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Claimant Id"
},
"completed_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Completed At"
},
"context": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"decision_actor_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Decision Actor Id"
},
"decisions": {
"items": {
"type": "string"
},
"title": "Decisions",
"type": "array"
},
"due_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Due At"
},
"expires_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Expires At"
},
"form_schema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"history": {
"items": {
"$ref": "#/components/schemas/HumanTaskAudit"
},
"maxItems": 100,
"title": "History",
"type": "array"
},
"history_truncated": {
"default": false,
"title": "History Truncated",
"type": "boolean"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"node_id": {
"title": "Node Id",
"type": "string"
},
"output": {
"anyOf": [
{
"$ref": "#/components/schemas/JsonObjectData-Output"
},
{
"type": "null"
}
],
"default": null
},
"revision": {
"minimum": 1,
"title": "Revision",
"type": "integer"
},
"run_id": {
"format": "uuid",
"title": "Run Id",
"type": "string"
},
"status": {
"enum": [
"ready",
"claimed",
"completed",
"expired",
"cancelled"
],
"title": "Status",
"type": "string"
},
"title": {
"title": "Title",
"type": "string"
}
},
"required": [
"id",
"run_id",
"node_id",
"revision",
"status",
"title",
"context",
"form_schema",
"decisions",
"assignment",
"created_at"
],
"title": "HumanTask",
"type": "object"
}HumanTaskAudit
{
"additionalProperties": false,
"properties": {
"action": {
"enum": [
"created",
"claim",
"release",
"reassign",
"complete",
"expired",
"cancelled"
],
"title": "Action",
"type": "string"
},
"actor_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Actor Id"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reason"
},
"revision": {
"minimum": 1,
"title": "Revision",
"type": "integer"
}
},
"required": [
"revision",
"action",
"created_at"
],
"title": "HumanTaskAudit",
"type": "object"
}HumanTaskCommand
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
}
},
"required": [
"expected_revision"
],
"title": "HumanTaskCommand",
"type": "object"
}HumanTaskNode
{
"additionalProperties": false,
"properties": {
"assignment": {
"$ref": "#/components/schemas/ResourceName"
},
"context": {
"$ref": "#/components/schemas/Expression-Output"
},
"decisions": {
"items": {
"$ref": "#/components/schemas/ResourceName"
},
"maxItems": 32,
"minItems": 1,
"title": "Decisions",
"type": "array"
},
"dueSeconds": {
"anyOf": [
{
"$ref": "#/components/schemas/PositiveInt"
},
{
"type": "null"
}
],
"default": null
},
"expirySeconds": {
"anyOf": [
{
"$ref": "#/components/schemas/PositiveInt"
},
{
"type": "null"
}
],
"default": null
},
"formSchema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"id": {
"$ref": "#/components/schemas/NodeId"
},
"kind": {
"const": "humanTask",
"title": "Kind",
"type": "string"
},
"path": {
"$ref": "#/components/schemas/JsonPointer"
},
"scope": {
"items": {
"$ref": "#/components/schemas/UnicodeString"
},
"maxItems": 64,
"title": "Scope",
"type": "array"
},
"title": {
"$ref": "#/components/schemas/Expression-Output"
}
},
"required": [
"id",
"scope",
"path",
"kind",
"assignment",
"title",
"context",
"formSchema",
"decisions"
],
"title": "HumanTaskNode",
"type": "object"
}HumanTaskStep-Input
{
"additionalProperties": false,
"properties": {
"assignment": {
"$ref": "#/components/schemas/ResourceName"
},
"context": {
"$ref": "#/components/schemas/Expression-Input"
},
"decisions": {
"items": {
"$ref": "#/components/schemas/ResourceName"
},
"maxItems": 32,
"minItems": 1,
"title": "Decisions",
"type": "array"
},
"dueSeconds": {
"$ref": "#/components/schemas/OmissionOnly_PositiveInt_"
},
"expirySeconds": {
"$ref": "#/components/schemas/OmissionOnly_PositiveInt_"
},
"formSchema": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "humanTask",
"title": "Kind",
"type": "string"
},
"title": {
"$ref": "#/components/schemas/Expression-Input"
}
},
"required": [
"id",
"kind",
"assignment",
"title",
"context",
"formSchema"
],
"title": "HumanTaskStep",
"type": "object"
}HumanTaskStep-Output
{
"additionalProperties": false,
"properties": {
"assignment": {
"$ref": "#/components/schemas/ResourceName"
},
"context": {
"$ref": "#/components/schemas/Expression-Output"
},
"decisions": {
"items": {
"$ref": "#/components/schemas/ResourceName"
},
"maxItems": 32,
"minItems": 1,
"title": "Decisions",
"type": "array"
},
"dueSeconds": {
"$ref": "#/components/schemas/OmissionOnly_PositiveInt_"
},
"expirySeconds": {
"$ref": "#/components/schemas/OmissionOnly_PositiveInt_"
},
"formSchema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "humanTask",
"title": "Kind",
"type": "string"
},
"title": {
"$ref": "#/components/schemas/Expression-Output"
}
},
"required": [
"id",
"kind",
"assignment",
"title",
"context",
"formSchema"
],
"title": "HumanTaskStep",
"type": "object"
}IREdge
{
"additionalProperties": false,
"properties": {
"branch": {
"anyOf": [
{
"$ref": "#/components/schemas/UnicodeString"
},
{
"type": "null"
}
]
},
"kind": {
"enum": [
"next",
"case",
"default",
"fork",
"join"
],
"title": "Kind",
"type": "string"
},
"source": {
"$ref": "#/components/schemas/NodeId"
},
"target": {
"$ref": "#/components/schemas/NodeId"
}
},
"required": [
"source",
"target",
"kind",
"branch"
],
"title": "IREdge",
"type": "object"
}IRGraph
{
"additionalProperties": false,
"properties": {
"edges": {
"items": {
"$ref": "#/components/schemas/IREdge"
},
"title": "Edges",
"type": "array"
},
"entry": {
"$ref": "#/components/schemas/NodeId"
},
"exit": {
"$ref": "#/components/schemas/NodeId"
},
"nodes": {
"items": {
"$ref": "#/components/schemas/IRNode"
},
"title": "Nodes",
"type": "array"
}
},
"required": [
"entry",
"exit",
"nodes",
"edges"
],
"title": "IRGraph",
"type": "object"
}IRNode
{
"discriminator": {
"mapping": {
"action": "#/components/schemas/ActionNode",
"branch-output": "#/components/schemas/BranchOutputNode",
"decisionTable": "#/components/schemas/DecisionTableNode",
"end": "#/components/schemas/EndNode",
"fail": "#/components/schemas/FailNode",
"humanTask": "#/components/schemas/HumanTaskNode",
"join": "#/components/schemas/JoinNode",
"parallel": "#/components/schemas/ParallelNode",
"signal": "#/components/schemas/SignalNode",
"start": "#/components/schemas/StartNode",
"switch": "#/components/schemas/SwitchNode",
"transform": "#/components/schemas/TransformNode",
"wait": "#/components/schemas/WaitNode"
},
"propertyName": "kind"
},
"oneOf": [
{
"$ref": "#/components/schemas/StartNode"
},
{
"$ref": "#/components/schemas/EndNode"
},
{
"$ref": "#/components/schemas/ActionNode"
},
{
"$ref": "#/components/schemas/DecisionTableNode"
},
{
"$ref": "#/components/schemas/TransformNode"
},
{
"$ref": "#/components/schemas/WaitNode"
},
{
"$ref": "#/components/schemas/SignalNode"
},
{
"$ref": "#/components/schemas/HumanTaskNode"
},
{
"$ref": "#/components/schemas/FailNode"
},
{
"$ref": "#/components/schemas/SwitchNode"
},
{
"$ref": "#/components/schemas/ParallelNode"
},
{
"$ref": "#/components/schemas/BranchOutputNode"
},
{
"$ref": "#/components/schemas/JoinNode"
}
]
}Identifier
{
"additionalProperties": false,
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
}
},
"required": [
"id"
],
"title": "Identifier",
"type": "object"
}IdentityEnvironment
{
"additionalProperties": false,
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "IdentityEnvironment",
"type": "object"
}IdentityGrant
{
"additionalProperties": false,
"properties": {
"capabilities": {
"items": {
"type": "string"
},
"title": "Capabilities",
"type": "array"
},
"resources": {
"items": {
"type": "string"
},
"title": "Resources",
"type": "array"
},
"role": {
"title": "Role",
"type": "string"
},
"scope": {
"anyOf": [
{
"$ref": "#/components/schemas/Scope"
},
{
"type": "null"
}
]
}
},
"required": [
"role",
"scope",
"resources",
"capabilities"
],
"title": "IdentityGrant",
"type": "object"
}IdentityProject
{
"additionalProperties": false,
"properties": {
"environments": {
"items": {
"$ref": "#/components/schemas/IdentityEnvironment"
},
"title": "Environments",
"type": "array"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name",
"environments"
],
"title": "IdentityProject",
"type": "object"
}IdentityView
{
"additionalProperties": false,
"properties": {
"grants": {
"items": {
"$ref": "#/components/schemas/IdentityGrant"
},
"title": "Grants",
"type": "array"
},
"kind": {
"enum": [
"human",
"application",
"worker"
],
"title": "Kind",
"type": "string"
},
"principal_id": {
"format": "uuid",
"title": "Principal Id",
"type": "string"
},
"truncated": {
"default": false,
"title": "Truncated",
"type": "boolean"
},
"workspaces": {
"items": {
"$ref": "#/components/schemas/IdentityWorkspace"
},
"title": "Workspaces",
"type": "array"
}
},
"required": [
"principal_id",
"kind",
"grants"
],
"title": "IdentityView",
"type": "object"
}IdentityWorkspace
{
"additionalProperties": false,
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"projects": {
"items": {
"$ref": "#/components/schemas/IdentityProject"
},
"title": "Projects",
"type": "array"
}
},
"required": [
"id",
"name",
"projects"
],
"title": "IdentityWorkspace",
"type": "object"
}ImageReference
{
"maxLength": 512,
"pattern": "^[a-zA-Z0-9][a-zA-Z0-9._:/-]*@sha256:[0-9a-f]{64}$",
"type": "string"
}IncidentResolution-Input
{
"additionalProperties": false,
"properties": {
"evidence_reference": {
"anyOf": [
{
"maxLength": 2000,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Evidence Reference"
},
"kind": {
"enum": [
"retry_safe",
"accept_reconciled_result",
"terminate"
],
"title": "Kind",
"type": "string"
},
"output": {
"$ref": "#/components/schemas/JsonData-Input",
"default": null
},
"reason": {
"maxLength": 2000,
"minLength": 1,
"title": "Reason",
"type": "string"
},
"receipt_id": {
"format": "uuid",
"title": "Receipt Id",
"type": "string"
}
},
"required": [
"receipt_id",
"kind",
"reason"
],
"title": "IncidentResolution",
"type": "object"
}IncidentResolution-Output
{
"additionalProperties": false,
"properties": {
"evidence_reference": {
"anyOf": [
{
"maxLength": 2000,
"minLength": 1,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Evidence Reference"
},
"kind": {
"enum": [
"retry_safe",
"accept_reconciled_result",
"terminate"
],
"title": "Kind",
"type": "string"
},
"output": {
"$ref": "#/components/schemas/JsonData-Output",
"default": null
},
"reason": {
"maxLength": 2000,
"minLength": 1,
"title": "Reason",
"type": "string"
},
"receipt_id": {
"format": "uuid",
"title": "Receipt Id",
"type": "string"
}
},
"required": [
"receipt_id",
"kind",
"reason"
],
"title": "IncidentResolution",
"type": "object"
}IncidentState
{
"additionalProperties": false,
"properties": {
"code": {
"title": "Code",
"type": "string"
},
"generation": {
"default": 0,
"minimum": 0,
"title": "Generation",
"type": "integer"
},
"node_id": {
"title": "Node Id",
"type": "string"
}
},
"required": [
"node_id",
"code"
],
"title": "IncidentState",
"type": "object"
}IncidentView
{
"additionalProperties": false,
"properties": {
"actor_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Actor Id"
},
"code": {
"title": "Code",
"type": "string"
},
"external_effects_may_continue": {
"default": false,
"title": "External Effects May Continue",
"type": "boolean"
},
"generation": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Generation"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"incident_key": {
"title": "Incident Key",
"type": "string"
},
"node_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Node Id"
},
"origin_code": {
"title": "Origin Code",
"type": "string"
},
"resolution": {
"anyOf": [
{
"$ref": "#/components/schemas/IncidentResolution-Output"
},
{
"type": "null"
}
],
"default": null
},
"resolved_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Resolved At"
},
"revision": {
"title": "Revision",
"type": "integer"
},
"run_id": {
"format": "uuid",
"title": "Run Id",
"type": "string"
},
"status": {
"enum": [
"active",
"closed",
"resolved"
],
"title": "Status",
"type": "string"
}
},
"required": [
"id",
"run_id",
"incident_key",
"node_id",
"generation",
"origin_code",
"code",
"status",
"revision"
],
"title": "IncidentView",
"type": "object"
}InstanceRequest
{
"additionalProperties": false,
"properties": {
"capacity": {
"maximum": 100,
"minimum": 1,
"title": "Capacity",
"type": "integer"
},
"release_id": {
"format": "uuid",
"title": "Release Id",
"type": "string"
},
"task_types": {
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 1,
"title": "Task Types",
"type": "array"
}
},
"required": [
"release_id",
"task_types",
"capacity"
],
"title": "InstanceRequest",
"type": "object"
}JobCancelRequest
{
"additionalProperties": false,
"properties": {
"reason": {
"const": "operator_cancelled",
"default": "operator_cancelled",
"title": "Reason",
"type": "string"
}
},
"title": "JobCancelRequest",
"type": "object"
}JobState
{
"enum": [
"queued",
"claimed",
"running",
"verifying",
"succeeded",
"failed",
"cancelled",
"reconciliation_required"
],
"type": "string"
}JoinNode
{
"additionalProperties": false,
"properties": {
"branches": {
"items": {
"$ref": "#/components/schemas/NodeId"
},
"minItems": 1,
"title": "Branches",
"type": "array"
},
"completes": {
"title": "Completes",
"type": "boolean"
},
"id": {
"$ref": "#/components/schemas/NodeId"
},
"kind": {
"const": "join",
"title": "Kind",
"type": "string"
},
"mode": {
"enum": [
"all",
"selected"
],
"title": "Mode",
"type": "string"
},
"owner": {
"$ref": "#/components/schemas/NodeId"
},
"path": {
"$ref": "#/components/schemas/JsonPointer"
},
"scope": {
"items": {
"$ref": "#/components/schemas/UnicodeString"
},
"maxItems": 64,
"title": "Scope",
"type": "array"
}
},
"required": [
"id",
"scope",
"path",
"kind",
"owner",
"mode",
"branches",
"completes"
],
"title": "JoinNode",
"type": "object"
}JoinState
{
"additionalProperties": false,
"properties": {
"branches": {
"items": {
"type": "string"
},
"title": "Branches",
"type": "array"
},
"completed": {
"items": {
"type": "string"
},
"title": "Completed",
"type": "array"
},
"completed_count": {
"default": 0,
"minimum": 0,
"title": "Completed Count",
"type": "integer"
},
"concurrency": {
"minimum": 1,
"title": "Concurrency",
"type": "integer"
},
"mode": {
"enum": [
"all",
"selected"
],
"title": "Mode",
"type": "string"
},
"node_id": {
"title": "Node Id",
"type": "string"
},
"owner": {
"title": "Owner",
"type": "string"
},
"required_count": {
"minimum": 1,
"title": "Required Count",
"type": "integer"
},
"status": {
"default": "waiting",
"enum": [
"waiting",
"joined",
"terminated"
],
"title": "Status",
"type": "string"
}
},
"required": [
"owner",
"node_id",
"mode",
"branches",
"concurrency",
"required_count"
],
"title": "JoinState",
"type": "object"
}JsonData-Input
{
"$ref": "#/components/schemas/JsonValue-Input"
}JsonData-Output
{
"$ref": "#/components/schemas/JsonValue-Output"
}JsonObject-Input
{
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue-Input"
},
"type": "object"
}JsonObject-Output
{
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue-Output"
},
"type": "object"
}JsonObjectData-Input
{
"$ref": "#/components/schemas/JsonObject-Input"
}JsonObjectData-Output
{
"$ref": "#/components/schemas/JsonObject-Output"
}JsonPointer
{
"allOf": [
{
"$ref": "#/components/schemas/UnicodeString_6__PydanticGeneralMetadata_pattern_________________01________"
},
{
"pattern": "^(?:/(?:[^~/]|~[01])*)*$",
"type": "string"
}
]
}JsonType
{
"enum": [
"array",
"boolean",
"integer",
"null",
"number",
"object",
"string"
],
"type": "string"
}JsonValue-Input
{
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/components/schemas/SafeInteger"
},
{
"$ref": "#/components/schemas/FiniteFloat"
},
{
"$ref": "#/components/schemas/UnicodeString"
},
{
"items": {
"$ref": "#/components/schemas/JsonValue-Input"
},
"type": "array"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue-Input"
},
"propertyNames": {
"$ref": "#/components/schemas/UnicodeString"
},
"type": "object"
},
{
"type": "null"
}
]
}JsonValue-Output
{
"anyOf": [
{
"type": "boolean"
},
{
"$ref": "#/components/schemas/SafeInteger"
},
{
"$ref": "#/components/schemas/FiniteFloat"
},
{
"$ref": "#/components/schemas/UnicodeString"
},
{
"items": {
"$ref": "#/components/schemas/JsonValue-Output"
},
"type": "array"
},
{
"additionalProperties": {
"$ref": "#/components/schemas/JsonValue-Output"
},
"propertyNames": {
"$ref": "#/components/schemas/UnicodeString"
},
"type": "object"
},
{
"type": "null"
}
]
}KindGroup
{
"enum": [
"actions",
"ai",
"data",
"flow",
"wait",
"human"
],
"type": "string"
}LLMOptions
{
"additionalProperties": false,
"properties": {
"max_tokens": {
"maximum": 32768,
"minimum": 1,
"title": "Max Tokens",
"type": "integer"
},
"output_verbosity": {
"enum": [
"low",
"medium",
"high"
],
"title": "Output Verbosity",
"type": "string"
},
"reasoning": {
"enum": [
"none",
"minimal",
"low",
"medium",
"high",
"xhigh"
],
"title": "Reasoning",
"type": "string"
},
"reasoning_budget_tokens": {
"maximum": 32768,
"minimum": 1,
"title": "Reasoning Budget Tokens",
"type": "integer"
},
"request_timeout": {
"exclusiveMinimum": 0,
"maximum": 600,
"title": "Request Timeout",
"type": "number"
},
"seed": {
"maximum": 2147483647,
"minimum": 0,
"title": "Seed",
"type": "integer"
},
"stop_sequences": {
"items": {
"maxLength": 256,
"minLength": 1,
"type": "string"
},
"maxItems": 16,
"title": "Stop Sequences",
"type": "array"
},
"temperature": {
"maximum": 2,
"minimum": 0,
"title": "Temperature",
"type": "number"
},
"top_k": {
"maximum": 1000,
"minimum": 1,
"title": "Top K",
"type": "integer"
},
"top_p": {
"maximum": 1,
"minimum": 0,
"title": "Top P",
"type": "number"
}
},
"required": [
"max_tokens"
],
"title": "LLMOptions",
"type": "object"
}LLMProfile-Input
{
"additionalProperties": false,
"properties": {
"maxCalls": {
"default": 8,
"maximum": 64,
"minimum": 1,
"title": "Maxcalls",
"type": "integer"
},
"model": {
"maxLength": 200,
"minLength": 1,
"pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]*$",
"title": "Model",
"type": "string"
},
"options": {
"$ref": "#/components/schemas/LLMOptions"
},
"outputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"provider": {
"enum": [
"openai-chat",
"openai-responses",
"azure-chat",
"azure-responses",
"anthropic"
],
"title": "Provider",
"type": "string"
},
"reasoning": {
"$ref": "#/components/schemas/LLMReasoning"
},
"timeoutSeconds": {
"default": 120,
"maximum": 600,
"minimum": 1,
"title": "Timeoutseconds",
"type": "integer"
}
},
"required": [
"provider",
"model",
"options",
"outputSchema"
],
"title": "LLMProfile",
"type": "object"
}LLMProfile-Output
{
"additionalProperties": false,
"properties": {
"maxCalls": {
"default": 8,
"maximum": 64,
"minimum": 1,
"title": "Maxcalls",
"type": "integer"
},
"model": {
"maxLength": 200,
"minLength": 1,
"pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]*$",
"title": "Model",
"type": "string"
},
"options": {
"$ref": "#/components/schemas/LLMOptions"
},
"outputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"provider": {
"enum": [
"openai-chat",
"openai-responses",
"azure-chat",
"azure-responses",
"anthropic"
],
"title": "Provider",
"type": "string"
},
"reasoning": {
"$ref": "#/components/schemas/LLMReasoning"
},
"timeoutSeconds": {
"default": 120,
"maximum": 600,
"minimum": 1,
"title": "Timeoutseconds",
"type": "integer"
}
},
"required": [
"provider",
"model",
"options",
"outputSchema"
],
"title": "LLMProfile",
"type": "object"
}LLMReasoning
{
"additionalProperties": false,
"properties": {
"maxSteps": {
"default": 6,
"maximum": 32,
"minimum": 1,
"title": "Maxsteps",
"type": "integer"
},
"pattern": {
"default": "none",
"enum": [
"none",
"react",
"chain_of_thought",
"plan_and_execute",
"reflexion",
"tree_of_thoughts",
"goal_decomposition"
],
"title": "Pattern",
"type": "string"
}
},
"title": "LLMReasoning",
"type": "object"
}LLMStep-Input
{
"additionalProperties": false,
"properties": {
"connection": {
"$ref": "#/components/schemas/ResourceName"
},
"context": {
"$ref": "#/components/schemas/Expression-Input"
},
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "llm",
"title": "Kind",
"type": "string"
},
"profile": {
"$ref": "#/components/schemas/ResourceName"
},
"prompt": {
"$ref": "#/components/schemas/Expression-Input"
},
"uses": {
"$ref": "#/components/schemas/VersionedReference"
}
},
"required": [
"id",
"kind",
"uses",
"profile",
"prompt",
"context",
"connection"
],
"title": "LLMStep",
"type": "object"
}LLMStep-Output
{
"additionalProperties": false,
"properties": {
"connection": {
"$ref": "#/components/schemas/ResourceName"
},
"context": {
"$ref": "#/components/schemas/Expression-Output"
},
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "llm",
"title": "Kind",
"type": "string"
},
"profile": {
"$ref": "#/components/schemas/ResourceName"
},
"prompt": {
"$ref": "#/components/schemas/Expression-Output"
},
"uses": {
"$ref": "#/components/schemas/VersionedReference"
}
},
"required": [
"id",
"kind",
"uses",
"profile",
"prompt",
"context",
"connection"
],
"title": "LLMStep",
"type": "object"
}LanguageFeature
{
"enum": [
"ai.agent",
"ai.memory",
"flow.callWorkflow",
"flow.forEach",
"text.concat",
"text.join"
],
"type": "string"
}LanguageManifest
{
"additionalProperties": false,
"properties": {
"features": {
"items": {
"$ref": "#/components/schemas/LanguageFeature"
},
"title": "Features",
"type": "array"
},
"ir_versions": {
"items": {
"type": "string"
},
"minItems": 1,
"title": "Ir Versions",
"type": "array"
},
"language_version": {
"const": "weave/v1alpha1",
"title": "Language Version",
"type": "string"
},
"limits": {
"$ref": "#/components/schemas/ManifestLimits"
},
"operators": {
"items": {
"$ref": "#/components/schemas/ManifestOperator"
},
"title": "Operators",
"type": "array"
},
"step_kinds": {
"items": {
"$ref": "#/components/schemas/ManifestStepKind"
},
"title": "Step Kinds",
"type": "array"
},
"version": {
"const": "weave/language-manifest-v1",
"title": "Version",
"type": "string"
},
"workflow_fields": {
"items": {
"$ref": "#/components/schemas/ManifestWorkflowField"
},
"title": "Workflow Fields",
"type": "array"
}
},
"required": [
"version",
"language_version",
"ir_versions",
"features",
"limits",
"operators",
"workflow_fields",
"step_kinds"
],
"title": "LanguageManifest",
"type": "object"
}LeaseProof
{
"additionalProperties": false,
"properties": {
"generation": {
"minimum": 1,
"title": "Generation",
"type": "integer"
},
"owner": {
"format": "uuid",
"title": "Owner",
"type": "string"
},
"task_id": {
"format": "uuid",
"title": "Task Id",
"type": "string"
},
"token": {
"maxLength": 200,
"minLength": 1,
"title": "Token",
"type": "string"
}
},
"required": [
"task_id",
"generation",
"owner",
"token"
],
"title": "LeaseProof",
"type": "object"
}LiteralExpression-Input
{
"additionalProperties": false,
"properties": {
"literal": {
"$ref": "#/components/schemas/JsonData-Input"
}
},
"required": [
"literal"
],
"title": "LiteralExpression",
"type": "object"
}LiteralExpression-Output
{
"additionalProperties": false,
"properties": {
"literal": {
"$ref": "#/components/schemas/JsonData-Output"
}
},
"required": [
"literal"
],
"title": "LiteralExpression",
"type": "object"
}LogCode
{
"maxLength": 100,
"minLength": 1,
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]*$",
"type": "string"
}LogFieldKey
{
"maxLength": 64,
"minLength": 1,
"pattern": "^[A-Za-z][A-Za-z0-9_.-]*$",
"type": "string"
}LogFieldValue
{
"anyOf": [
{
"maxLength": 256,
"type": "string"
},
{
"$ref": "#/components/schemas/SafeInteger"
},
{
"$ref": "#/components/schemas/FiniteFloat"
},
{
"type": "boolean"
},
{
"type": "null"
}
]
}LogLevel
{
"enum": [
"debug",
"info",
"warning",
"error"
],
"type": "string"
}LogSource
{
"enum": [
"engine",
"worker",
"connector",
"ai"
],
"type": "string"
}LumiAskRequest
{
"additionalProperties": false,
"properties": {
"attachments": {
"items": {
"$ref": "#/components/schemas/LumiAttachment"
},
"maxItems": 4,
"title": "Attachments",
"type": "array"
},
"draft": {
"anyOf": [
{
"$ref": "#/components/schemas/LumiDraft"
},
{
"type": "null"
}
],
"default": null
},
"history": {
"items": {
"$ref": "#/components/schemas/LumiMessage"
},
"maxItems": 16,
"title": "History",
"type": "array"
},
"message": {
"maxLength": 20000,
"minLength": 1,
"title": "Message",
"type": "string"
}
},
"required": [
"message"
],
"title": "LumiAskRequest",
"type": "object"
}LumiAttachment
{
"additionalProperties": false,
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"kind": {
"enum": [
"draft",
"run",
"simulation",
"deployment-target",
"deployment",
"deployment-observation",
"deployment-plan",
"deployment-job"
],
"title": "Kind",
"type": "string"
}
},
"required": [
"kind",
"id"
],
"title": "LumiAttachment",
"type": "object"
}LumiConfiguration
{
"additionalProperties": false,
"properties": {
"connection_revision_id": {
"format": "uuid",
"title": "Connection Revision Id",
"type": "string"
},
"enabled": {
"default": true,
"title": "Enabled",
"type": "boolean"
},
"profile": {
"$ref": "#/components/schemas/LumiProfile-Output"
},
"revision": {
"minimum": 1,
"title": "Revision",
"type": "integer"
}
},
"required": [
"connection_revision_id",
"profile",
"revision"
],
"title": "LumiConfiguration",
"type": "object"
}LumiConfigurationRequest
{
"additionalProperties": false,
"properties": {
"connection_revision_id": {
"format": "uuid",
"title": "Connection Revision Id",
"type": "string"
},
"enabled": {
"default": true,
"title": "Enabled",
"type": "boolean"
},
"profile": {
"$ref": "#/components/schemas/LumiProfile-Input"
}
},
"required": [
"connection_revision_id",
"profile"
],
"title": "LumiConfigurationRequest",
"type": "object"
}LumiDraft
{
"additionalProperties": false,
"properties": {
"format": {
"enum": [
"yaml",
"json"
],
"title": "Format",
"type": "string"
},
"source": {
"maxLength": 262144,
"minLength": 1,
"title": "Source",
"type": "string"
}
},
"required": [
"format",
"source"
],
"title": "LumiDraft",
"type": "object"
}LumiMessage
{
"additionalProperties": false,
"properties": {
"content": {
"maxLength": 20000,
"minLength": 1,
"title": "Content",
"type": "string"
},
"role": {
"enum": [
"user",
"assistant"
],
"title": "Role",
"type": "string"
}
},
"required": [
"role",
"content"
],
"title": "LumiMessage",
"type": "object"
}LumiProfile-Input
{
"additionalProperties": false,
"properties": {
"maxCalls": {
"default": 8,
"maximum": 64,
"minimum": 1,
"title": "Maxcalls",
"type": "integer"
},
"model": {
"maxLength": 200,
"minLength": 1,
"pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]*$",
"title": "Model",
"type": "string"
},
"options": {
"$ref": "#/components/schemas/LLMOptions"
},
"outputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Input",
"const": {
"additionalProperties": false,
"properties": {
"answer": {
"maxLength": 20000,
"minLength": 1,
"title": "Answer",
"type": "string"
},
"followUps": {
"items": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"maxItems": 5,
"title": "Followups",
"type": "array"
},
"proposals": {
"items": {
"additionalProperties": false,
"properties": {
"format": {
"enum": [
"yaml",
"json"
],
"title": "Format",
"type": "string"
},
"kind": {
"enum": [
"workflow",
"decisionTable",
"action",
"connector"
],
"title": "Kind",
"type": "string"
},
"source": {
"maxLength": 100000,
"minLength": 1,
"title": "Source",
"type": "string"
},
"title": {
"maxLength": 200,
"minLength": 1,
"title": "Title",
"type": "string"
}
},
"required": [
"title",
"kind",
"format",
"source"
],
"title": "LumiProposal",
"type": "object"
},
"maxItems": 5,
"title": "Proposals",
"type": "array"
}
},
"required": [
"answer"
],
"title": "LumiReply",
"type": "object"
}
},
"provider": {
"enum": [
"openai-chat",
"openai-responses",
"azure-chat",
"azure-responses",
"anthropic"
],
"title": "Provider",
"type": "string"
},
"reasoning": {
"$ref": "#/components/schemas/LLMReasoning"
},
"timeoutSeconds": {
"default": 120,
"maximum": 600,
"minimum": 1,
"title": "Timeoutseconds",
"type": "integer"
}
},
"required": [
"provider",
"model",
"options",
"outputSchema"
],
"title": "LumiProfile",
"type": "object"
}LumiProfile-Output
{
"additionalProperties": false,
"properties": {
"maxCalls": {
"default": 8,
"maximum": 64,
"minimum": 1,
"title": "Maxcalls",
"type": "integer"
},
"model": {
"maxLength": 200,
"minLength": 1,
"pattern": "^[A-Za-z0-9][A-Za-z0-9._:/-]*$",
"title": "Model",
"type": "string"
},
"options": {
"$ref": "#/components/schemas/LLMOptions"
},
"outputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Output",
"const": {
"additionalProperties": false,
"properties": {
"answer": {
"maxLength": 20000,
"minLength": 1,
"title": "Answer",
"type": "string"
},
"followUps": {
"items": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"maxItems": 5,
"title": "Followups",
"type": "array"
},
"proposals": {
"items": {
"additionalProperties": false,
"properties": {
"format": {
"enum": [
"yaml",
"json"
],
"title": "Format",
"type": "string"
},
"kind": {
"enum": [
"workflow",
"decisionTable",
"action",
"connector"
],
"title": "Kind",
"type": "string"
},
"source": {
"maxLength": 100000,
"minLength": 1,
"title": "Source",
"type": "string"
},
"title": {
"maxLength": 200,
"minLength": 1,
"title": "Title",
"type": "string"
}
},
"required": [
"title",
"kind",
"format",
"source"
],
"title": "LumiProposal",
"type": "object"
},
"maxItems": 5,
"title": "Proposals",
"type": "array"
}
},
"required": [
"answer"
],
"title": "LumiReply",
"type": "object"
}
},
"provider": {
"enum": [
"openai-chat",
"openai-responses",
"azure-chat",
"azure-responses",
"anthropic"
],
"title": "Provider",
"type": "string"
},
"reasoning": {
"$ref": "#/components/schemas/LLMReasoning"
},
"timeoutSeconds": {
"default": 120,
"maximum": 600,
"minimum": 1,
"title": "Timeoutseconds",
"type": "integer"
}
},
"required": [
"provider",
"model",
"options",
"outputSchema"
],
"title": "LumiProfile",
"type": "object"
}LumiProposal
{
"additionalProperties": false,
"properties": {
"format": {
"enum": [
"yaml",
"json"
],
"title": "Format",
"type": "string"
},
"kind": {
"enum": [
"workflow",
"decisionTable",
"action",
"connector"
],
"title": "Kind",
"type": "string"
},
"source": {
"maxLength": 100000,
"minLength": 1,
"title": "Source",
"type": "string"
},
"title": {
"maxLength": 200,
"minLength": 1,
"title": "Title",
"type": "string"
}
},
"required": [
"title",
"kind",
"format",
"source"
],
"title": "LumiProposal",
"type": "object"
}LumiReply
{
"additionalProperties": false,
"properties": {
"answer": {
"maxLength": 20000,
"minLength": 1,
"title": "Answer",
"type": "string"
},
"followUps": {
"items": {
"maxLength": 1000,
"minLength": 1,
"type": "string"
},
"maxItems": 5,
"title": "Followups",
"type": "array"
},
"proposals": {
"items": {
"$ref": "#/components/schemas/LumiProposal"
},
"maxItems": 5,
"title": "Proposals",
"type": "array"
}
},
"required": [
"answer"
],
"title": "LumiReply",
"type": "object"
}LumiStatus
{
"additionalProperties": false,
"properties": {
"configured": {
"title": "Configured",
"type": "boolean"
},
"model": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Model"
},
"provider": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Provider"
},
"revision": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Revision"
}
},
"required": [
"configured"
],
"title": "LumiStatus",
"type": "object"
}ManifestBlock
{
"additionalProperties": false,
"description": "A nested Branch at a fixed path: its steps are at ``path + \"/steps\"`` and its output at ``path + \"/output\"``.",
"properties": {
"label": {
"minLength": 1,
"title": "Label",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"path": {
"pattern": "^(?:/[A-Za-z]+)+$",
"title": "Path",
"type": "string"
}
},
"required": [
"name",
"path",
"label"
],
"title": "ManifestBlock",
"type": "object"
}ManifestLimits
{
"additionalProperties": false,
"properties": {
"default_loop_max_items": {
"$ref": "#/components/schemas/PositiveInt"
},
"max_call_depth": {
"$ref": "#/components/schemas/PositiveInt"
},
"max_concurrency": {
"$ref": "#/components/schemas/PositiveInt"
},
"max_loop_depth": {
"$ref": "#/components/schemas/PositiveInt"
},
"max_loop_items": {
"$ref": "#/components/schemas/PositiveInt"
},
"max_run_iterations": {
"$ref": "#/components/schemas/PositiveInt"
}
},
"required": [
"max_loop_items",
"default_loop_max_items",
"max_loop_depth",
"max_concurrency",
"max_run_iterations",
"max_call_depth"
],
"title": "ManifestLimits",
"type": "object"
}ManifestOperator
{
"additionalProperties": false,
"properties": {
"arity": {
"$ref": "#/components/schemas/Arity"
},
"feature": {
"$ref": "#/components/schemas/OmissionOnly_LanguageFeature_"
},
"item_types": {
"$ref": "#/components/schemas/OmissionOnly_list_JsonType__"
},
"label": {
"minLength": 1,
"title": "Label",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
},
"operand_types": {
"items": {
"items": {
"$ref": "#/components/schemas/JsonType"
},
"type": "array"
},
"minItems": 1,
"title": "Operand Types",
"type": "array"
},
"repeat_last": {
"default": false,
"title": "Repeat Last",
"type": "boolean"
},
"result": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"studio": {
"$ref": "#/components/schemas/StudioMark"
}
},
"required": [
"name",
"arity",
"operand_types",
"result",
"label",
"studio"
],
"title": "ManifestOperator",
"type": "object"
}ManifestStepKind
{
"additionalProperties": false,
"properties": {
"blocks": {
"items": {
"$ref": "#/components/schemas/ManifestBlock"
},
"title": "Blocks",
"type": "array"
},
"feature": {
"$ref": "#/components/schemas/OmissionOnly_LanguageFeature_"
},
"group": {
"$ref": "#/components/schemas/KindGroup"
},
"kind": {
"title": "Kind",
"type": "string"
},
"label": {
"minLength": 1,
"title": "Label",
"type": "string"
},
"schema_ref": {
"pattern": "^workflow\\.schema\\.json#/\\$defs/[A-Za-z]+$",
"title": "Schema Ref",
"type": "string"
},
"scope_roots": {
"items": {
"type": "string"
},
"title": "Scope Roots",
"type": "array"
},
"studio": {
"$ref": "#/components/schemas/StudioMark"
}
},
"required": [
"kind",
"schema_ref",
"group",
"label",
"blocks",
"scope_roots",
"studio"
],
"title": "ManifestStepKind",
"type": "object"
}ManifestWorkflowField
{
"additionalProperties": false,
"properties": {
"feature": {
"$ref": "#/components/schemas/OmissionOnly_LanguageFeature_"
},
"name": {
"title": "Name",
"type": "string"
},
"studio": {
"$ref": "#/components/schemas/StudioMark"
}
},
"required": [
"name",
"studio"
],
"title": "ManifestWorkflowField",
"type": "object"
}ManualControlRequest
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 0,
"title": "Expected Revision",
"type": "integer"
},
"reason": {
"maxLength": 2000,
"minLength": 1,
"title": "Reason",
"type": "string"
}
},
"required": [
"expected_revision",
"reason"
],
"title": "ManualControlRequest",
"type": "object"
}MemberBinding
{
"additionalProperties": false,
"properties": {
"active": {
"title": "Active",
"type": "boolean"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"kind": {
"enum": [
"human",
"application",
"worker"
],
"title": "Kind",
"type": "string"
},
"principal_id": {
"format": "uuid",
"title": "Principal Id",
"type": "string"
},
"resources": {
"items": {
"type": "string"
},
"title": "Resources",
"type": "array"
},
"role": {
"enum": [
"platform_admin",
"tenant_admin",
"developer",
"deployer",
"operator",
"viewer",
"worker",
"task_participant",
"task_manager",
"email_reader",
"email_sender",
"email_manager",
"execution_manager",
"lumi_user",
"lumi_manager",
"file_reader",
"file_manager",
"deployment_reader",
"deployment_planner",
"deployment_approver",
"deployment_operator",
"deployment_runner",
"worker_operator"
],
"title": "Role",
"type": "string"
},
"scope": {
"$ref": "#/components/schemas/Scope"
}
},
"required": [
"id",
"principal_id",
"kind",
"active",
"role",
"scope",
"resources"
],
"title": "MemberBinding",
"type": "object"
}MemberGrantRequest
{
"additionalProperties": false,
"properties": {
"environment_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Environment Id"
},
"principal_id": {
"format": "uuid",
"title": "Principal Id",
"type": "string"
},
"project_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Project Id"
},
"resources": {
"default": [],
"items": {
"type": "string"
},
"maxItems": 100,
"title": "Resources",
"type": "array"
},
"role": {
"enum": [
"platform_admin",
"tenant_admin",
"developer",
"deployer",
"operator",
"viewer",
"worker",
"task_participant",
"task_manager",
"email_reader",
"email_sender",
"email_manager",
"execution_manager",
"lumi_user",
"lumi_manager",
"file_reader",
"file_manager",
"deployment_reader",
"deployment_planner",
"deployment_approver",
"deployment_operator",
"deployment_runner",
"worker_operator"
],
"title": "Role",
"type": "string"
}
},
"required": [
"principal_id",
"role"
],
"title": "MemberGrantRequest",
"type": "object"
}MessageId
{
"maxLength": 256,
"minLength": 1,
"pattern": "^[!-~]+$",
"type": "string"
}Metadata
{
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"version": {
"$ref": "#/components/schemas/SemVer"
}
},
"required": [
"name",
"version"
],
"title": "Metadata",
"type": "object"
}Milliseconds
{
"minimum": 0,
"type": "integer"
}NameRequest
{
"additionalProperties": false,
"properties": {
"name": {
"maxLength": 200,
"minLength": 1,
"title": "Name",
"type": "string"
}
},
"required": [
"name"
],
"title": "NameRequest",
"type": "object"
}NamedResource
{
"additionalProperties": false,
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"name": {
"title": "Name",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "NamedResource",
"type": "object"
}NodeId
{
"$ref": "#/components/schemas/UnicodeString",
"minLength": 1
}NormalizedEmail
{
"additionalProperties": false,
"properties": {
"attachments": {
"default": [],
"items": {
"$ref": "#/components/schemas/AttachmentMetadata"
},
"title": "Attachments",
"type": "array"
},
"automated": {
"default": false,
"title": "Automated",
"type": "boolean"
},
"cc": {
"default": [],
"items": {
"type": "string"
},
"title": "Cc",
"type": "array"
},
"in_reply_to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "In Reply To"
},
"message_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Message Id"
},
"references": {
"default": [],
"items": {
"type": "string"
},
"title": "References",
"type": "array"
},
"reply_to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Reply To"
},
"sender": {
"title": "Sender",
"type": "string"
},
"subject": {
"title": "Subject",
"type": "string"
},
"text": {
"title": "Text",
"type": "string"
},
"to": {
"items": {
"type": "string"
},
"title": "To",
"type": "array"
}
},
"required": [
"sender",
"to",
"subject",
"text"
],
"title": "NormalizedEmail",
"type": "object"
}ObjectExpression-Input
{
"additionalProperties": false,
"properties": {
"object": {
"additionalProperties": {
"$ref": "#/components/schemas/Expression-Input"
},
"propertyNames": {
"$ref": "#/components/schemas/UnicodeString"
},
"title": "Object",
"type": "object"
}
},
"required": [
"object"
],
"title": "ObjectExpression",
"type": "object"
}ObjectExpression-Output
{
"additionalProperties": false,
"properties": {
"object": {
"additionalProperties": {
"$ref": "#/components/schemas/Expression-Output"
},
"propertyNames": {
"$ref": "#/components/schemas/UnicodeString"
},
"title": "Object",
"type": "object"
}
},
"required": [
"object"
],
"title": "ObjectExpression",
"type": "object"
}ObservationReport
{
"additionalProperties": false,
"properties": {
"complete": {
"title": "Complete",
"type": "boolean"
},
"resources": {
"items": {
"$ref": "#/components/schemas/ObservedResource"
},
"maxItems": 100,
"title": "Resources",
"type": "array"
},
"settled": {
"default": false,
"title": "Settled",
"type": "boolean"
}
},
"required": [
"resources",
"complete"
],
"title": "ObservationReport",
"type": "object"
}ObserveRequest
{
"additionalProperties": false,
"properties": {
"target_id": {
"format": "uuid",
"title": "Target Id",
"type": "string"
}
},
"required": [
"target_id"
],
"title": "ObserveRequest",
"type": "object"
}ObservedResource
{
"additionalProperties": false,
"properties": {
"external_identity": {
"$ref": "#/components/schemas/ExternalIdentity"
},
"image": {
"anyOf": [
{
"$ref": "#/components/schemas/ImageReference"
},
{
"type": "null"
}
],
"default": null
},
"kind": {
"enum": [
"api",
"worker",
"lumi",
"migration",
"unknown"
],
"title": "Kind",
"type": "string"
},
"name": {
"$ref": "#/components/schemas/DeploymentName"
},
"ownership": {
"enum": [
"managed",
"imported",
"unknown"
],
"title": "Ownership",
"type": "string"
},
"ready_replicas": {
"maximum": 10000,
"minimum": 0,
"title": "Ready Replicas",
"type": "integer"
},
"replicas": {
"maximum": 10000,
"minimum": 0,
"title": "Replicas",
"type": "integer"
},
"state": {
"enum": [
"ready",
"progressing",
"stopped",
"failed",
"unknown"
],
"title": "State",
"type": "string"
},
"version": {
"$ref": "#/components/schemas/ExternalIdentity"
}
},
"required": [
"name",
"external_identity",
"kind",
"replicas",
"ready_replicas",
"version",
"ownership",
"state"
],
"title": "ObservedResource",
"type": "object"
}Omission
{
"additionalProperties": false,
"properties": {
"path": {
"title": "Path",
"type": "string"
},
"reason": {
"enum": [
"classified_secret",
"classification_unavailable",
"uncertain_derived",
"confidential_text",
"resource_limit"
],
"title": "Reason",
"type": "string"
}
},
"required": [
"path",
"reason"
],
"title": "Omission",
"type": "object"
}OmissionOnly_CallableSpec_
{
"$ref": "#/components/schemas/CallableSpec"
}OmissionOnly_CallerNames_
{
"$ref": "#/components/schemas/CallerNames"
}OmissionOnly_ConnectionRequirement_
{
"$ref": "#/components/schemas/ConnectionRequirement"
}OmissionOnly_Expression_-Input
{
"$ref": "#/components/schemas/Expression-Input"
}OmissionOnly_Expression_-Output
{
"$ref": "#/components/schemas/Expression-Output"
}OmissionOnly_JsonObjectData_-Input
{
"$ref": "#/components/schemas/JsonObjectData-Input"
}OmissionOnly_JsonObjectData_-Output
{
"$ref": "#/components/schemas/JsonObjectData-Output"
}OmissionOnly_LanguageFeature_
{
"$ref": "#/components/schemas/LanguageFeature"
}OmissionOnly_Literal__stop____continue___
{
"enum": [
"stop",
"continue"
],
"type": "string"
}OmissionOnly_PositiveInt_
{
"$ref": "#/components/schemas/PositiveInt"
}OmissionOnly_ResourceName_
{
"$ref": "#/components/schemas/ResourceName"
}OmissionOnly_WorkerRouting_
{
"$ref": "#/components/schemas/WorkerRouting"
}OmissionOnly_dict_ResourceName__LLMProfile___MaxLen_max_length_32_-Input
{
"additionalProperties": {
"$ref": "#/components/schemas/LLMProfile-Input"
},
"propertyNames": {
"$ref": "#/components/schemas/ResourceName"
},
"type": "object"
}OmissionOnly_dict_ResourceName__LLMProfile___MaxLen_max_length_32_-Output
{
"additionalProperties": {
"$ref": "#/components/schemas/LLMProfile-Output"
},
"propertyNames": {
"$ref": "#/components/schemas/ResourceName"
},
"type": "object"
}OmissionOnly_list_JsonType__
{
"items": {
"$ref": "#/components/schemas/JsonType"
},
"type": "array"
}OpExpression-Input
{
"additionalProperties": false,
"properties": {
"op": {
"$ref": "#/components/schemas/Operation-Input"
}
},
"required": [
"op"
],
"title": "OpExpression",
"type": "object"
}OpExpression-Output
{
"additionalProperties": false,
"properties": {
"op": {
"$ref": "#/components/schemas/Operation-Output"
}
},
"required": [
"op"
],
"title": "OpExpression",
"type": "object"
}Operation-Input
{
"additionalProperties": false,
"properties": {
"args": {
"items": {
"$ref": "#/components/schemas/Expression-Input"
},
"title": "Args",
"type": "array"
},
"name": {
"$ref": "#/components/schemas/OperatorName"
}
},
"required": [
"name",
"args"
],
"title": "Operation",
"type": "object"
}Operation-Output
{
"additionalProperties": false,
"properties": {
"args": {
"items": {
"$ref": "#/components/schemas/Expression-Output"
},
"title": "Args",
"type": "array"
},
"name": {
"$ref": "#/components/schemas/OperatorName"
}
},
"required": [
"name",
"args"
],
"title": "Operation",
"type": "object"
}OperationalCapabilities
{
"additionalProperties": false,
"description": "Effective project policy and fixed server ceilings, not worker negotiation.",
"properties": {
"compatibility": {
"$ref": "#/components/schemas/CompatibilityAvailability"
},
"debug": {
"$ref": "#/components/schemas/DebugCapabilities"
},
"policy": {
"$ref": "#/components/schemas/OperationsPolicy"
},
"policy_fingerprint": {
"pattern": "^[a-f0-9]{64}$",
"title": "Policy Fingerprint",
"type": "string"
},
"process": {
"$ref": "#/components/schemas/ProcessCapabilities"
},
"runtime": {
"$ref": "#/components/schemas/RuntimeCapabilities"
},
"transport": {
"$ref": "#/components/schemas/TransportCapabilities"
},
"worker_protocol_versions": {
"items": {
"const": "weave/worker-v1",
"type": "string"
},
"maxItems": 1,
"minItems": 1,
"title": "Worker Protocol Versions",
"type": "array"
}
},
"required": [
"policy",
"policy_fingerprint",
"worker_protocol_versions",
"transport",
"runtime",
"process",
"debug",
"compatibility"
],
"title": "OperationalCapabilities",
"type": "object"
}OperationsPolicy
{
"additionalProperties": false,
"properties": {
"bindings_retained": {
"default": 1000,
"maximum": 1000,
"minimum": 1,
"title": "Bindings Retained",
"type": "integer"
},
"control_bytes": {
"default": 4294967296,
"maximum": 4294967296,
"minimum": 1,
"title": "Control Bytes",
"type": "integer"
},
"debug_rows": {
"default": 1000,
"maximum": 1000,
"minimum": 1,
"title": "Debug Rows",
"type": "integer"
},
"ordinary_bytes": {
"default": 4294967296,
"maximum": 4294967296,
"minimum": 1,
"title": "Ordinary Bytes",
"type": "integer"
},
"outbox_pending": {
"default": 10000,
"maximum": 10000,
"minimum": 1,
"title": "Outbox Pending",
"type": "integer"
},
"provider_pending": {
"default": 10000,
"maximum": 10000,
"minimum": 1,
"title": "Provider Pending",
"type": "integer"
},
"provider_pending_bytes": {
"default": 67108864,
"maximum": 67108864,
"minimum": 1,
"title": "Provider Pending Bytes",
"type": "integer"
},
"provider_receipts": {
"default": 100000,
"maximum": 100000,
"minimum": 1,
"title": "Provider Receipts",
"type": "integer"
},
"revision": {
"const": "weave/operations-v1",
"default": "weave/operations-v1",
"title": "Revision",
"type": "string"
},
"runs_active": {
"default": 1000,
"maximum": 1000,
"minimum": 1,
"title": "Runs Active",
"type": "integer"
},
"runs_retained": {
"default": 10000,
"maximum": 10000,
"minimum": 1,
"title": "Runs Retained",
"type": "integer"
},
"sources_enabled": {
"default": 100,
"maximum": 100,
"minimum": 1,
"title": "Sources Enabled",
"type": "integer"
},
"sources_retained": {
"default": 1000,
"maximum": 1000,
"minimum": 1,
"title": "Sources Retained",
"type": "integer"
},
"task_input_bytes": {
"default": 67108864,
"maximum": 67108864,
"minimum": 1,
"title": "Task Input Bytes",
"type": "integer"
},
"tasks_active": {
"default": 10000,
"maximum": 10000,
"minimum": 1,
"title": "Tasks Active",
"type": "integer"
},
"teams_lifecycle_events": {
"default": 100000,
"maximum": 100000,
"minimum": 1,
"title": "Teams Lifecycle Events",
"type": "integer"
},
"teams_reference_commands": {
"default": 100000,
"maximum": 100000,
"minimum": 1,
"title": "Teams Reference Commands",
"type": "integer"
},
"teams_references": {
"default": 10000,
"maximum": 10000,
"minimum": 1,
"title": "Teams References",
"type": "integer"
},
"waits_active": {
"default": 10000,
"maximum": 10000,
"minimum": 1,
"title": "Waits Active",
"type": "integer"
},
"whatsapp_message_states": {
"default": 100000,
"maximum": 100000,
"minimum": 1,
"title": "Whatsapp Message States",
"type": "integer"
},
"whatsapp_status_facts": {
"default": 100000,
"maximum": 100000,
"minimum": 1,
"title": "Whatsapp Status Facts",
"type": "integer"
},
"whatsapp_status_observations": {
"default": 100000,
"maximum": 100000,
"minimum": 1,
"title": "Whatsapp Status Observations",
"type": "integer"
}
},
"title": "OperationsPolicy",
"type": "object"
}OperatorName
{
"enum": [
"eq",
"ne",
"lt",
"lte",
"gt",
"gte",
"and",
"or",
"not",
"exists",
"coalesce",
"contains",
"notContains",
"in",
"notIn",
"startsWith",
"endsWith",
"concat",
"join"
],
"type": "string"
}PageLimit
{
"maximum": 100,
"minimum": 1,
"type": "integer"
}Page_Activation_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Activation"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[Activation]",
"type": "object"
}Page_BrokerIncident_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/BrokerIncident"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[BrokerIncident]",
"type": "object"
}Page_BrokerTrigger_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/BrokerTrigger"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[BrokerTrigger]",
"type": "object"
}Page_ConnectorDescriptorView_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ConnectorDescriptorView"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[ConnectorDescriptorView]",
"type": "object"
}Page_DeliveryAttempt_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/DeliveryAttempt"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[DeliveryAttempt]",
"type": "object"
}Page_DeliveryView_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/DeliveryView"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[DeliveryView]",
"type": "object"
}Page_DeploymentJob_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/DeploymentJob"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[DeploymentJob]",
"type": "object"
}Page_DeploymentObservation_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/DeploymentObservation"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[DeploymentObservation]",
"type": "object"
}Page_DeploymentPlan_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/DeploymentPlan"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[DeploymentPlan]",
"type": "object"
}Page_DeploymentRunner_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/DeploymentRunner"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[DeploymentRunner]",
"type": "object"
}Page_DeploymentTarget_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/DeploymentTarget"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[DeploymentTarget]",
"type": "object"
}Page_Deployment_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Deployment"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[Deployment]",
"type": "object"
}Page_EmailConversation_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/EmailConversation"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[EmailConversation]",
"type": "object"
}Page_EmailReceipt_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/EmailReceipt"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[EmailReceipt]",
"type": "object"
}Page_FileUpload_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/FileUpload"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[FileUpload]",
"type": "object"
}Page_HumanTask_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/HumanTask"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[HumanTask]",
"type": "object"
}Page_MemberBinding_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/MemberBinding"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[MemberBinding]",
"type": "object"
}Page_PrincipalRecord_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/PrincipalRecord"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[PrincipalRecord]",
"type": "object"
}Page_ProviderReceipt_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ProviderReceipt"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[ProviderReceipt]",
"type": "object"
}Page_ProviderSource_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ProviderSource"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[ProviderSource]",
"type": "object"
}Page_ScheduleOccurrence_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ScheduleOccurrence"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[ScheduleOccurrence]",
"type": "object"
}Page_ScheduleView_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/ScheduleView"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[ScheduleView]",
"type": "object"
}Page_SourceBinding_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/SourceBinding"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[SourceBinding]",
"type": "object"
}Page_Subscription_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Subscription"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[Subscription]",
"type": "object"
}Page_TeamsReference_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/TeamsReference"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[TeamsReference]",
"type": "object"
}Page_Trigger_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/Trigger"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[Trigger]",
"type": "object"
}Page_WhatsAppStatusFact_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/WhatsAppStatusFact"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[WhatsAppStatusFact]",
"type": "object"
}Page_WorkerRelease_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/WorkerRelease"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[WorkerRelease]",
"type": "object"
}Page_WorkerStatus_
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/WorkerStatus"
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
}
},
"required": [
"items"
],
"title": "Page[WorkerStatus]",
"type": "object"
}ParallelNode
{
"additionalProperties": false,
"properties": {
"branches": {
"items": {
"$ref": "#/components/schemas/ForkBranch"
},
"minItems": 1,
"title": "Branches",
"type": "array"
},
"concurrency": {
"$ref": "#/components/schemas/PositiveInt"
},
"id": {
"$ref": "#/components/schemas/NodeId"
},
"join": {
"$ref": "#/components/schemas/NodeId"
},
"kind": {
"const": "parallel",
"title": "Kind",
"type": "string"
},
"path": {
"$ref": "#/components/schemas/JsonPointer"
},
"scope": {
"items": {
"$ref": "#/components/schemas/UnicodeString"
},
"maxItems": 64,
"title": "Scope",
"type": "array"
}
},
"required": [
"id",
"scope",
"path",
"kind",
"branches",
"concurrency",
"join"
],
"title": "ParallelNode",
"type": "object"
}ParallelStep-Input
{
"additionalProperties": false,
"properties": {
"branches": {
"additionalProperties": {
"$ref": "#/components/schemas/Branch-Input"
},
"minProperties": 1,
"propertyNames": {
"$ref": "#/components/schemas/ResourceName"
},
"title": "Branches",
"type": "object"
},
"concurrency": {
"$ref": "#/components/schemas/PositiveInt"
},
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "parallel",
"title": "Kind",
"type": "string"
}
},
"required": [
"id",
"kind",
"branches",
"concurrency"
],
"title": "ParallelStep",
"type": "object"
}ParallelStep-Output
{
"additionalProperties": false,
"properties": {
"branches": {
"additionalProperties": {
"$ref": "#/components/schemas/Branch-Output"
},
"minProperties": 1,
"propertyNames": {
"$ref": "#/components/schemas/ResourceName"
},
"title": "Branches",
"type": "object"
},
"concurrency": {
"$ref": "#/components/schemas/PositiveInt"
},
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "parallel",
"title": "Kind",
"type": "string"
}
},
"required": [
"id",
"kind",
"branches",
"concurrency"
],
"title": "ParallelStep",
"type": "object"
}Phone
{
"pattern": "^[0-9]{1,15}$",
"type": "string"
}PlanApproval
{
"additionalProperties": false,
"properties": {
"approved_at": {
"format": "date-time",
"title": "Approved At",
"type": "string"
},
"digest": {
"$ref": "#/components/schemas/firefly_weave__contracts__catalog__Digest"
},
"plan_id": {
"format": "uuid",
"title": "Plan Id",
"type": "string"
},
"principal_id": {
"format": "uuid",
"title": "Principal Id",
"type": "string"
}
},
"required": [
"plan_id",
"digest",
"principal_id",
"approved_at"
],
"title": "PlanApproval",
"type": "object"
}PlanApprovalRequest
{
"additionalProperties": false,
"properties": {
"digest": {
"$ref": "#/components/schemas/firefly_weave__contracts__catalog__Digest"
}
},
"required": [
"digest"
],
"title": "PlanApprovalRequest",
"type": "object"
}PlanRequest
{
"additionalProperties": false,
"properties": {
"deployment_id": {
"format": "uuid",
"title": "Deployment Id",
"type": "string"
},
"deployment_revision": {
"minimum": 1,
"title": "Deployment Revision",
"type": "integer"
},
"intent": {
"enum": [
"deploy",
"update",
"scale_workers",
"drain_workers"
],
"title": "Intent",
"type": "string"
},
"observation_id": {
"format": "uuid",
"title": "Observation Id",
"type": "string"
},
"ttl_seconds": {
"default": 300,
"maximum": 900,
"minimum": 30,
"title": "Ttl Seconds",
"type": "integer"
}
},
"required": [
"deployment_id",
"deployment_revision",
"observation_id",
"intent"
],
"title": "PlanRequest",
"type": "object"
}PlanStep
{
"additionalProperties": false,
"properties": {
"action": {
"enum": [
"deploy",
"update",
"scale_workers",
"drain_workers"
],
"title": "Action",
"type": "string"
},
"component": {
"$ref": "#/components/schemas/ComponentSpec"
},
"expected_version": {
"anyOf": [
{
"$ref": "#/components/schemas/ExternalIdentity"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"action",
"component"
],
"title": "PlanStep",
"type": "object"
}PositiveInt
{
"exclusiveMinimum": 0,
"maximum": 9007199254740991,
"type": "integer"
}PrincipalCreateRequest
{
"additionalProperties": false,
"properties": {
"kind": {
"default": "human",
"enum": [
"human",
"application",
"worker"
],
"title": "Kind",
"type": "string"
}
},
"title": "PrincipalCreateRequest",
"type": "object"
}PrincipalIdentityRequest
{
"additionalProperties": false,
"properties": {
"issuer": {
"maxLength": 2048,
"minLength": 1,
"title": "Issuer",
"type": "string"
},
"provider_id": {
"maxLength": 128,
"minLength": 1,
"title": "Provider Id",
"type": "string"
},
"subject": {
"maxLength": 512,
"minLength": 1,
"title": "Subject",
"type": "string"
}
},
"required": [
"provider_id",
"issuer",
"subject"
],
"title": "PrincipalIdentityRequest",
"type": "object"
}PrincipalIdentityResult
{
"additionalProperties": false,
"properties": {
"issuer": {
"maxLength": 2048,
"minLength": 1,
"title": "Issuer",
"type": "string"
},
"principal_id": {
"format": "uuid",
"title": "Principal Id",
"type": "string"
},
"provider_id": {
"maxLength": 128,
"minLength": 1,
"title": "Provider Id",
"type": "string"
},
"subject": {
"maxLength": 512,
"minLength": 1,
"title": "Subject",
"type": "string"
}
},
"required": [
"provider_id",
"issuer",
"subject",
"principal_id"
],
"title": "PrincipalIdentityResult",
"type": "object"
}PrincipalRecord
{
"additionalProperties": false,
"properties": {
"active": {
"title": "Active",
"type": "boolean"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"kind": {
"enum": [
"human",
"application",
"worker"
],
"title": "Kind",
"type": "string"
}
},
"required": [
"kind",
"id",
"active"
],
"title": "PrincipalRecord",
"type": "object"
}PrincipalStatusRequest
{
"additionalProperties": false,
"properties": {
"active": {
"title": "Active",
"type": "boolean"
}
},
"required": [
"active"
],
"title": "PrincipalStatusRequest",
"type": "object"
}Problem
{
"additionalProperties": false,
"properties": {
"code": {
"title": "Code",
"type": "string"
},
"diagnostics": {
"items": {
"$ref": "#/components/schemas/Diagnostic"
},
"title": "Diagnostics",
"type": "array"
},
"message": {
"title": "Message",
"type": "string"
},
"request_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Request Id"
},
"result": {
"anyOf": [
{
"$ref": "#/components/schemas/JsonObjectData-Output"
},
{
"type": "null"
}
],
"default": null
},
"status": {
"maximum": 599,
"minimum": 400,
"title": "Status",
"type": "integer"
}
},
"required": [
"status",
"code",
"message"
],
"title": "Problem",
"type": "object"
}ProcessCapabilities
{
"additionalProperties": false,
"description": "Process-wide admission ceilings, including unfinished synchronous secret calls.",
"properties": {
"body_bytes": {
"exclusiveMinimum": 0,
"title": "Body Bytes",
"type": "integer"
},
"body_slots": {
"exclusiveMinimum": 0,
"title": "Body Slots",
"type": "integer"
},
"control_body_bytes": {
"exclusiveMinimum": 0,
"title": "Control Body Bytes",
"type": "integer"
},
"control_body_slots": {
"exclusiveMinimum": 0,
"title": "Control Body Slots",
"type": "integer"
},
"control_slots": {
"exclusiveMinimum": 0,
"title": "Control Slots",
"type": "integer"
},
"debug_body_slots": {
"exclusiveMinimum": 0,
"title": "Debug Body Slots",
"type": "integer"
},
"debug_execution_slots": {
"exclusiveMinimum": 0,
"title": "Debug Execution Slots",
"type": "integer"
},
"secret_slots": {
"exclusiveMinimum": 0,
"title": "Secret Slots",
"type": "integer"
},
"work_slots": {
"exclusiveMinimum": 0,
"title": "Work Slots",
"type": "integer"
}
},
"required": [
"work_slots",
"control_slots",
"secret_slots",
"body_slots",
"body_bytes",
"control_body_slots",
"control_body_bytes",
"debug_body_slots",
"debug_execution_slots"
],
"title": "ProcessCapabilities",
"type": "object"
}ProviderReceipt
{
"additionalProperties": false,
"properties": {
"attempts": {
"default": 0,
"minimum": 0,
"title": "Attempts",
"type": "integer"
},
"event_id": {
"$ref": "#/components/schemas/EventIdentity"
},
"fingerprint": {
"$ref": "#/components/schemas/firefly_weave__contracts__providers__Digest"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"kind": {
"$ref": "#/components/schemas/ResourceName"
},
"provider": {
"$ref": "#/components/schemas/ResourceName"
},
"reason": {
"anyOf": [
{
"$ref": "#/components/schemas/SafeReason"
},
{
"type": "null"
}
],
"default": null
},
"received_at": {
"format": "date-time",
"title": "Received At",
"type": "string"
},
"run_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Run Id"
},
"signal_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Signal Id"
},
"source_id": {
"format": "uuid",
"title": "Source Id",
"type": "string"
},
"state": {
"enum": [
"pending",
"dispatched",
"ignored",
"blocked",
"failed"
],
"title": "State",
"type": "string"
}
},
"required": [
"id",
"source_id",
"provider",
"event_id",
"kind",
"fingerprint",
"received_at",
"state"
],
"title": "ProviderReceipt",
"type": "object"
}ProviderSource
{
"additionalProperties": false,
"properties": {
"activation_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Activation Id"
},
"adapter_version": {
"$ref": "#/components/schemas/SemVer"
},
"binding_id": {
"format": "uuid",
"title": "Binding Id",
"type": "string"
},
"connection_revision_id": {
"format": "uuid",
"title": "Connection Revision Id",
"type": "string"
},
"disabled": {
"default": false,
"title": "Disabled",
"type": "boolean"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"kind": {
"enum": [
"run",
"signal"
],
"title": "Kind",
"type": "string"
},
"mapping": {
"$ref": "#/components/schemas/Expression-Output"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"package": {
"$ref": "#/components/schemas/ResourceName"
},
"package_version": {
"$ref": "#/components/schemas/DistributionVersion"
},
"policy": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"principal_id": {
"format": "uuid",
"title": "Principal Id",
"type": "string"
},
"provider": {
"$ref": "#/components/schemas/ResourceName"
},
"run_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Run Id"
},
"schema_digest": {
"$ref": "#/components/schemas/firefly_weave__contracts__providers__Digest"
},
"scope": {
"$ref": "#/components/schemas/Scope"
},
"signal": {
"anyOf": [
{
"$ref": "#/components/schemas/ResourceName"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name",
"provider",
"package",
"package_version",
"adapter_version",
"schema_digest",
"connection_revision_id",
"policy",
"kind",
"id",
"scope",
"binding_id",
"principal_id"
],
"title": "ProviderSource",
"type": "object"
}ProviderSourceRequest
{
"additionalProperties": false,
"properties": {
"activation_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Activation Id"
},
"adapter_version": {
"anyOf": [
{
"$ref": "#/components/schemas/SemVer"
},
{
"type": "null"
}
],
"default": null
},
"connection_revision_id": {
"format": "uuid",
"title": "Connection Revision Id",
"type": "string"
},
"kind": {
"enum": [
"run",
"signal"
],
"title": "Kind",
"type": "string"
},
"mapping": {
"$ref": "#/components/schemas/Expression-Input"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"package": {
"$ref": "#/components/schemas/ResourceName"
},
"package_version": {
"$ref": "#/components/schemas/DistributionVersion"
},
"policy": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"provider": {
"$ref": "#/components/schemas/ResourceName"
},
"run_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Run Id"
},
"schema_digest": {
"$ref": "#/components/schemas/firefly_weave__contracts__providers__Digest"
},
"signal": {
"anyOf": [
{
"$ref": "#/components/schemas/ResourceName"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"name",
"provider",
"package",
"package_version",
"schema_digest",
"connection_revision_id",
"policy",
"kind"
],
"title": "ProviderSourceRequest",
"type": "object"
}PublicationRequest
{
"additionalProperties": false,
"properties": {
"format": {
"enum": [
"yaml",
"json"
],
"title": "Format",
"type": "string"
},
"source": {
"title": "Source",
"type": "string"
}
},
"required": [
"source",
"format"
],
"title": "PublicationRequest",
"type": "object"
}PublishedVersion
{
"additionalProperties": false,
"properties": {
"definition_digest": {
"$ref": "#/components/schemas/firefly_weave__contracts__catalog__Digest"
},
"digest": {
"$ref": "#/components/schemas/firefly_weave__contracts__catalog__Digest"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"kind": {
"$ref": "#/components/schemas/DefinitionKind"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"version": {
"$ref": "#/components/schemas/SemVer"
}
},
"required": [
"id",
"kind",
"name",
"version",
"digest",
"definition_digest"
],
"title": "PublishedVersion",
"type": "object"
}ReassignHumanTask
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
},
"principal_id": {
"format": "uuid",
"title": "Principal Id",
"type": "string"
},
"reason": {
"maxLength": 2000,
"minLength": 1,
"title": "Reason",
"type": "string"
}
},
"required": [
"expected_revision",
"principal_id",
"reason"
],
"title": "ReassignHumanTask",
"type": "object"
}ReconcileJobRequest
{
"additionalProperties": false,
"properties": {
"external_operation_stopped": {
"const": true,
"title": "External Operation Stopped",
"type": "boolean"
},
"observation_id": {
"format": "uuid",
"title": "Observation Id",
"type": "string"
},
"plan_digest": {
"$ref": "#/components/schemas/firefly_weave__contracts__catalog__Digest"
}
},
"required": [
"plan_digest",
"observation_id",
"external_operation_stopped"
],
"title": "ReconcileJobRequest",
"type": "object"
}RefExpression
{
"additionalProperties": false,
"properties": {
"ref": {
"$ref": "#/components/schemas/JsonPointer"
}
},
"required": [
"ref"
],
"title": "RefExpression",
"type": "object"
}RelatedLocation
{
"additionalProperties": false,
"properties": {
"message": {
"anyOf": [
{
"$ref": "#/components/schemas/UnicodeString"
},
{
"type": "null"
}
],
"default": null
},
"path": {
"$ref": "#/components/schemas/JsonPointer"
},
"source": {
"anyOf": [
{
"$ref": "#/components/schemas/SourceRange"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"path"
],
"title": "RelatedLocation",
"type": "object"
}ReleaseRequest
{
"additionalProperties": false,
"properties": {
"capabilities": {
"items": {
"$ref": "#/components/schemas/TaskCapability-Input"
},
"maxItems": 100,
"minItems": 1,
"title": "Capabilities",
"type": "array"
},
"connector_bindings": {
"items": {
"$ref": "#/components/schemas/ConnectorBinding"
},
"title": "Connector Bindings",
"type": "array"
},
"credential_capabilities": {
"items": {
"type": "string"
},
"maxItems": 100,
"title": "Credential Capabilities",
"type": "array"
},
"image_digest": {
"pattern": "^sha256:[a-f0-9]{64}$",
"title": "Image Digest",
"type": "string"
}
},
"required": [
"image_digest",
"capabilities"
],
"title": "ReleaseRequest",
"type": "object"
}ReplayDiagnostic
{
"additionalProperties": false,
"properties": {
"code": {
"title": "Code",
"type": "string"
},
"sequence": {
"minimum": 0,
"title": "Sequence",
"type": "integer"
}
},
"required": [
"code",
"sequence"
],
"title": "ReplayDiagnostic",
"type": "object"
}ReplayReport
{
"additionalProperties": false,
"properties": {
"authorization_verified": {
"const": false,
"default": false,
"title": "Authorization Verified",
"type": "boolean"
},
"diagnostics": {
"items": {
"$ref": "#/components/schemas/ReplayDiagnostic"
},
"maxItems": 100,
"title": "Diagnostics",
"type": "array"
},
"final_state": {
"anyOf": [
{
"$ref": "#/components/schemas/RunState"
},
{
"type": "null"
}
],
"default": null
},
"last_verified_sequence": {
"default": 0,
"minimum": 0,
"title": "Last Verified Sequence",
"type": "integer"
},
"omissions": {
"items": {
"$ref": "#/components/schemas/Omission"
},
"title": "Omissions",
"type": "array"
},
"status": {
"enum": [
"consistent",
"inconsistent",
"incomplete"
],
"title": "Status",
"type": "string"
}
},
"required": [
"status"
],
"title": "ReplayReport",
"type": "object"
}ResourceName
{
"allOf": [
{
"$ref": "#/components/schemas/UnicodeString_A-Za-z0-9__-_____"
},
{
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]*$",
"type": "string"
}
]
}RetentionApplication
{
"additionalProperties": false,
"properties": {
"blocked": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 100,
"title": "Blocked",
"type": "array"
},
"deleted": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 100,
"title": "Deleted",
"type": "array"
},
"plan_id": {
"format": "uuid",
"title": "Plan Id",
"type": "string"
},
"policy": {
"const": "weave/operations-v1",
"default": "weave/operations-v1",
"title": "Policy",
"type": "string"
}
},
"required": [
"plan_id",
"deleted",
"blocked"
],
"title": "RetentionApplication",
"type": "object"
}RetentionCandidate
{
"additionalProperties": false,
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"reason": {
"enum": [
"expired_debug",
"referenced"
],
"title": "Reason",
"type": "string"
},
"revision": {
"minimum": 1,
"title": "Revision",
"type": "integer"
}
},
"required": [
"id",
"revision",
"reason"
],
"title": "RetentionCandidate",
"type": "object"
}RetentionOmission
{
"additionalProperties": false,
"properties": {
"reason": {
"enum": [
"unresolved_references",
"deduplication_window_unknown",
"provider_fence_required",
"history_preserved"
],
"title": "Reason",
"type": "string"
},
"resource": {
"enum": [
"runtime_history",
"deduplication",
"source_payloads",
"teams_references",
"whatsapp_facts",
"catalog",
"outbox"
],
"title": "Resource",
"type": "string"
}
},
"required": [
"resource",
"reason"
],
"title": "RetentionOmission",
"type": "object"
}RetentionPlan
{
"additionalProperties": false,
"properties": {
"candidates": {
"items": {
"$ref": "#/components/schemas/RetentionCandidate"
},
"maxItems": 100,
"title": "Candidates",
"type": "array"
},
"complete": {
"title": "Complete",
"type": "boolean"
},
"created_at": {
"format": "date-time",
"title": "Created At",
"type": "string"
},
"cutoff": {
"format": "date-time",
"title": "Cutoff",
"type": "string"
},
"expires_at": {
"format": "date-time",
"title": "Expires At",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"next_cursor": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Next Cursor"
},
"omissions": {
"items": {
"$ref": "#/components/schemas/RetentionOmission"
},
"maxItems": 7,
"title": "Omissions",
"type": "array"
},
"policy": {
"const": "weave/operations-v1",
"default": "weave/operations-v1",
"title": "Policy",
"type": "string"
},
"principal_id": {
"format": "uuid",
"title": "Principal Id",
"type": "string"
},
"scope": {
"$ref": "#/components/schemas/Scope"
}
},
"required": [
"id",
"scope",
"principal_id",
"created_at",
"cutoff",
"expires_at",
"complete",
"candidates"
],
"title": "RetentionPlan",
"type": "object"
}RetentionRequest
{
"additionalProperties": false,
"properties": {
"after": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "After"
},
"limit": {
"default": 100,
"maximum": 100,
"minimum": 1,
"title": "Limit",
"type": "integer"
},
"target": {
"const": "expired_debug",
"default": "expired_debug",
"title": "Target",
"type": "string"
}
},
"title": "RetentionRequest",
"type": "object"
}RetiredVersion
{
"additionalProperties": false,
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"retired": {
"const": true,
"default": true,
"title": "Retired",
"type": "boolean"
}
},
"required": [
"id"
],
"title": "RetiredVersion",
"type": "object"
}RetirementRequest
{
"additionalProperties": false,
"properties": {},
"title": "RetirementRequest",
"type": "object"
}RetryPolicy
{
"additionalProperties": false,
"properties": {
"initialDelaySeconds": {
"$ref": "#/components/schemas/PositiveInt",
"default": 1
},
"maxAttempts": {
"$ref": "#/components/schemas/PositiveInt",
"default": 1
},
"maxDelaySeconds": {
"$ref": "#/components/schemas/PositiveInt",
"default": 30
}
},
"title": "RetryPolicy",
"type": "object"
}RevisionTag
{
"pattern": "^(?:\"[1-9][0-9]{0,9}\"|[1-9][0-9]{0,9})$",
"type": "string"
}Revoked
{
"additionalProperties": false,
"properties": {
"revoked": {
"const": true,
"default": true,
"title": "Revoked",
"type": "boolean"
}
},
"title": "Revoked",
"type": "object"
}RunLifecycle
{
"additionalProperties": false,
"properties": {
"archived": {
"default": false,
"title": "Archived",
"type": "boolean"
},
"archived_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Archived At"
},
"purged": {
"default": false,
"title": "Purged",
"type": "boolean"
},
"purged_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Purged At"
},
"revision": {
"default": 0,
"title": "Revision",
"type": "integer"
},
"run_id": {
"format": "uuid",
"title": "Run Id",
"type": "string"
}
},
"required": [
"run_id"
],
"title": "RunLifecycle",
"type": "object"
}RunLifecycleRequest
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 0,
"title": "Expected Revision",
"type": "integer"
},
"reason": {
"maxLength": 500,
"minLength": 1,
"title": "Reason",
"type": "string"
}
},
"required": [
"expected_revision",
"reason"
],
"title": "RunLifecycleRequest",
"type": "object"
}RunLogEntry
{
"additionalProperties": false,
"description": "One run log entry: engine entries come from run events, the others from execution logs.",
"properties": {
"at": {
"format": "date-time",
"title": "At",
"type": "string"
},
"attempt": {
"anyOf": [
{
"minimum": 1,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Attempt"
},
"code": {
"anyOf": [
{
"$ref": "#/components/schemas/LogCode"
},
{
"type": "null"
}
]
},
"fields": {
"additionalProperties": {
"$ref": "#/components/schemas/LogFieldValue"
},
"maxProperties": 16,
"propertyNames": {
"$ref": "#/components/schemas/LogFieldKey"
},
"title": "Fields",
"type": "object"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"instance_key": {
"maxLength": 512,
"pattern": "^(?:@?[A-Za-z0-9][A-Za-z0-9_.:@-]*(?:\\[(?:0|[1-9][0-9]{0,14}|[1-8][0-9]{15}|900[0-6][0-9]{12}|90070[0-9]{11}|90071[0-8][0-9]{10}|900719[0-8][0-9]{9}|9007199[0-1][0-9]{8}|90071992[0-4][0-9]{7}|900719925[0-3][0-9]{6}|9007199254[0-6][0-9]{5}|90071992547[0-3][0-9]{4}|9007199254740[0-8][0-9]{2}|90071992547409[0-8][0-9]|9007199254740990|9007199254740991)\\])*(?:#[A-Za-z0-9]+(?:\\.[A-Za-z0-9]+)*)?(?:~(?:[1-9][0-9]{0,14}|[1-8][0-9]{15}|900[0-6][0-9]{12}|90070[0-9]{11}|90071[0-8][0-9]{10}|900719[0-8][0-9]{9}|9007199[0-1][0-9]{8}|90071992[0-4][0-9]{7}|900719925[0-3][0-9]{6}|9007199254[0-6][0-9]{5}|90071992547[0-3][0-9]{4}|9007199254740[0-8][0-9]{2}|90071992547409[0-8][0-9]|9007199254740990|9007199254740991))?)?$",
"title": "Instance Key",
"type": "string"
},
"level": {
"$ref": "#/components/schemas/LogLevel"
},
"message": {
"maxLength": 512,
"title": "Message",
"type": "string"
},
"node_id": {
"anyOf": [
{
"$ref": "#/components/schemas/ResourceName"
},
{
"type": "null"
}
]
},
"redactions": {
"$ref": "#/components/schemas/Count"
},
"source": {
"$ref": "#/components/schemas/LogSource"
},
"truncated": {
"title": "Truncated",
"type": "boolean"
},
"worker_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Worker Id"
}
},
"required": [
"id",
"at",
"source",
"level",
"code",
"message",
"node_id",
"instance_key",
"attempt",
"worker_id",
"fields",
"redactions",
"truncated"
],
"title": "RunLogEntry",
"type": "object"
}RunLogPage
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"$ref": "#/components/schemas/RunLogEntry"
},
"maxItems": 500,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"$ref": "#/components/schemas/Cursor"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"items"
],
"title": "RunLogPage",
"type": "object"
}RunOrigin
{
"enum": [
"manual",
"webhook",
"schedule",
"broker",
"email",
"provider",
"retry",
"call",
"test"
],
"type": "string"
}RunPurgeRequest
{
"additionalProperties": false,
"properties": {
"confirm_run_id": {
"format": "uuid",
"title": "Confirm Run Id",
"type": "string"
},
"expected_revision": {
"minimum": 0,
"title": "Expected Revision",
"type": "integer"
},
"reason": {
"maxLength": 500,
"minLength": 1,
"title": "Reason",
"type": "string"
}
},
"required": [
"expected_revision",
"reason",
"confirm_run_id"
],
"title": "RunPurgeRequest",
"type": "object"
}RunState
{
"additionalProperties": false,
"properties": {
"accepted_sequence": {
"default": 0,
"minimum": 0,
"title": "Accepted Sequence",
"type": "integer"
},
"active": {
"items": {
"type": "string"
},
"title": "Active",
"type": "array"
},
"admission_policy": {
"anyOf": [
{
"const": "classified-v1",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Admission Policy"
},
"branches": {
"additionalProperties": {
"$ref": "#/components/schemas/BranchState"
},
"title": "Branches",
"type": "object"
},
"control_revision": {
"default": 0,
"minimum": 0,
"title": "Control Revision",
"type": "integer"
},
"deferred_results": {
"items": {
"$ref": "#/components/schemas/RuntimeEvent"
},
"title": "Deferred Results",
"type": "array"
},
"incident": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Incident"
},
"incidents": {
"additionalProperties": {
"$ref": "#/components/schemas/IncidentState"
},
"title": "Incidents",
"type": "object"
},
"input": {
"$ref": "#/components/schemas/JsonData-Output",
"default": null
},
"joins": {
"additionalProperties": {
"$ref": "#/components/schemas/JoinState"
},
"title": "Joins",
"type": "object"
},
"manual_paused": {
"default": false,
"title": "Manual Paused",
"type": "boolean"
},
"output": {
"$ref": "#/components/schemas/JsonData-Output",
"default": null
},
"status": {
"default": "queued",
"enum": [
"queued",
"running",
"waiting",
"suspended",
"succeeded",
"failed",
"cancelled",
"timed_out"
],
"title": "Status",
"type": "string"
},
"steps": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"unavailable": {
"default": false,
"title": "Unavailable",
"type": "boolean"
},
"waits": {
"additionalProperties": {
"format": "date-time",
"type": "string"
},
"title": "Waits",
"type": "object"
}
},
"title": "RunState",
"type": "object"
}RunStatus
{
"enum": [
"queued",
"running",
"waiting",
"suspended",
"succeeded",
"failed",
"cancelled",
"timed_out"
],
"type": "string"
}RunSummary
{
"additionalProperties": false,
"description": "One `run_summaries.list` item, read from run facts only and never from run payloads.",
"properties": {
"activation": {
"$ref": "#/components/schemas/RunSummaryActivation"
},
"activation_id": {
"format": "uuid",
"title": "Activation Id",
"type": "string"
},
"active_incidents": {
"$ref": "#/components/schemas/Count"
},
"archived": {
"title": "Archived",
"type": "boolean"
},
"business_key": {
"anyOf": [
{
"$ref": "#/components/schemas/BusinessKey"
},
{
"type": "null"
}
]
},
"caller": {
"anyOf": [
{
"$ref": "#/components/schemas/RunSummaryCaller"
},
{
"type": "null"
}
]
},
"correlation_key": {
"anyOf": [
{
"$ref": "#/components/schemas/BusinessKey"
},
{
"type": "null"
}
]
},
"duration_ms": {
"anyOf": [
{
"$ref": "#/components/schemas/Milliseconds"
},
{
"type": "null"
}
]
},
"ended_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Ended At"
},
"failed_step": {
"anyOf": [
{
"$ref": "#/components/schemas/FailedStep"
},
{
"type": "null"
}
]
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"origin": {
"anyOf": [
{
"$ref": "#/components/schemas/RunOrigin"
},
{
"type": "null"
}
]
},
"paused": {
"title": "Paused",
"type": "boolean"
},
"retried_from_run_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Retried From Run Id"
},
"started_at": {
"format": "date-time",
"title": "Started At",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/RunStatus"
},
"test": {
"title": "Test",
"type": "boolean"
},
"updated_at": {
"format": "date-time",
"title": "Updated At",
"type": "string"
},
"workflow": {
"$ref": "#/components/schemas/RunSummaryWorkflow"
}
},
"required": [
"id",
"workflow",
"activation_id",
"activation",
"status",
"paused",
"test",
"origin",
"caller",
"retried_from_run_id",
"started_at",
"updated_at",
"ended_at",
"duration_ms",
"business_key",
"correlation_key",
"failed_step",
"active_incidents",
"archived"
],
"title": "RunSummary",
"type": "object"
}RunSummaryActivation
{
"additionalProperties": false,
"properties": {
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"revision": {
"minimum": 1,
"title": "Revision",
"type": "integer"
}
},
"required": [
"name",
"revision"
],
"title": "RunSummaryActivation",
"type": "object"
}RunSummaryCaller
{
"additionalProperties": false,
"properties": {
"instance_key": {
"maxLength": 512,
"pattern": "^(?:@?[A-Za-z0-9][A-Za-z0-9_.:@-]*(?:\\[(?:0|[1-9][0-9]{0,14}|[1-8][0-9]{15}|900[0-6][0-9]{12}|90070[0-9]{11}|90071[0-8][0-9]{10}|900719[0-8][0-9]{9}|9007199[0-1][0-9]{8}|90071992[0-4][0-9]{7}|900719925[0-3][0-9]{6}|9007199254[0-6][0-9]{5}|90071992547[0-3][0-9]{4}|9007199254740[0-8][0-9]{2}|90071992547409[0-8][0-9]|9007199254740990|9007199254740991)\\])*(?:#[A-Za-z0-9]+(?:\\.[A-Za-z0-9]+)*)?(?:~(?:[1-9][0-9]{0,14}|[1-8][0-9]{15}|900[0-6][0-9]{12}|90070[0-9]{11}|90071[0-8][0-9]{10}|900719[0-8][0-9]{9}|9007199[0-1][0-9]{8}|90071992[0-4][0-9]{7}|900719925[0-3][0-9]{6}|9007199254[0-6][0-9]{5}|90071992547[0-3][0-9]{4}|9007199254740[0-8][0-9]{2}|90071992547409[0-8][0-9]|9007199254740990|9007199254740991))?)?$",
"title": "Instance Key",
"type": "string"
},
"node_id": {
"$ref": "#/components/schemas/ResourceName"
},
"run_id": {
"format": "uuid",
"title": "Run Id",
"type": "string"
}
},
"required": [
"run_id",
"node_id",
"instance_key"
],
"title": "RunSummaryCaller",
"type": "object"
}RunSummaryOrder
{
"enum": [
"started_desc",
"started_asc",
"updated_desc"
],
"type": "string"
}RunSummaryPage
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/RunSummary"
},
{
"$ref": "#/components/schemas/UnavailableResource"
}
]
},
"maxItems": 100,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"$ref": "#/components/schemas/Cursor"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"items"
],
"title": "RunSummaryPage",
"type": "object"
}RunSummaryWorkflow
{
"additionalProperties": false,
"properties": {
"definition_version_id": {
"format": "uuid",
"title": "Definition Version Id",
"type": "string"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"version": {
"$ref": "#/components/schemas/SemVer"
}
},
"required": [
"name",
"version",
"definition_version_id"
],
"title": "RunSummaryWorkflow",
"type": "object"
}RunView
{
"additionalProperties": false,
"properties": {
"activation": {
"$ref": "#/components/schemas/Activation"
},
"artifact_digest": {
"title": "Artifact Digest",
"type": "string"
},
"business_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Business Key"
},
"correlation_key": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Correlation Key"
},
"external_effects_may_continue": {
"default": false,
"title": "External Effects May Continue",
"type": "boolean"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"parent_run_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Parent Run Id"
},
"state": {
"$ref": "#/components/schemas/RunState"
}
},
"required": [
"id",
"activation",
"artifact_digest",
"state"
],
"title": "RunView",
"type": "object"
}RunnerClaimRequest
{
"additionalProperties": false,
"properties": {
"runner_id": {
"format": "uuid",
"title": "Runner Id",
"type": "string"
}
},
"required": [
"runner_id"
],
"title": "RunnerClaimRequest",
"type": "object"
}RunnerRegistration
{
"additionalProperties": false,
"properties": {
"adapter": {
"$ref": "#/components/schemas/AdapterKind"
},
"adapter_version": {
"const": "1",
"default": "1",
"title": "Adapter Version",
"type": "string"
},
"capabilities": {
"items": {
"$ref": "#/components/schemas/DeploymentCapability"
},
"maxItems": 5,
"minItems": 1,
"title": "Capabilities",
"type": "array"
},
"target_id": {
"format": "uuid",
"title": "Target Id",
"type": "string"
}
},
"required": [
"target_id",
"adapter",
"capabilities"
],
"title": "RunnerRegistration",
"type": "object"
}RunnerReport
{
"additionalProperties": false,
"properties": {
"lease": {
"$ref": "#/components/schemas/DeploymentLeaseProof"
},
"observation": {
"anyOf": [
{
"$ref": "#/components/schemas/ObservationReport"
},
{
"type": "null"
}
],
"default": null
},
"receipt": {
"anyOf": [
{
"$ref": "#/components/schemas/SafeDeploymentReceipt"
},
{
"type": "null"
}
],
"default": null
},
"report_id": {
"format": "uuid",
"title": "Report Id",
"type": "string"
},
"state": {
"enum": [
"running",
"verifying",
"succeeded",
"failed",
"cancelled",
"reconciliation_required"
],
"title": "State",
"type": "string"
}
},
"required": [
"lease",
"report_id",
"state"
],
"title": "RunnerReport",
"type": "object"
}RuntimeCapabilities
{
"additionalProperties": false,
"description": "Logical allocation ceilings per runtime transition; these are not RSS limits.",
"properties": {
"intents_per_turn": {
"exclusiveMinimum": 0,
"title": "Intents Per Turn",
"type": "integer"
},
"reductions_per_turn": {
"exclusiveMinimum": 0,
"title": "Reductions Per Turn",
"type": "integer"
},
"state_bytes": {
"exclusiveMinimum": 0,
"title": "State Bytes",
"type": "integer"
},
"transition_bytes": {
"exclusiveMinimum": 0,
"title": "Transition Bytes",
"type": "integer"
}
},
"required": [
"state_bytes",
"transition_bytes",
"reductions_per_turn",
"intents_per_turn"
],
"title": "RuntimeCapabilities",
"type": "object"
}RuntimeEvent
{
"additionalProperties": false,
"properties": {
"data": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"evidence": {
"anyOf": [
{
"$ref": "#/components/schemas/JsonObjectData-Output"
},
{
"type": "null"
}
],
"default": null
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"sequence": {
"default": 0,
"minimum": 0,
"title": "Sequence",
"type": "integer"
},
"timestamp": {
"format": "date-time",
"title": "Timestamp",
"type": "string"
},
"type": {
"enum": [
"started",
"task_completed",
"task_failed",
"signal_received",
"human_completed",
"paused",
"resumed",
"wait_elapsed",
"timed_out",
"recovery_scheduled",
"incident_opened",
"incident_resolved",
"cancelled"
],
"title": "Type",
"type": "string"
}
},
"required": [
"id",
"type",
"timestamp"
],
"title": "RuntimeEvent",
"type": "object"
}SafeDeploymentReceipt
{
"additionalProperties": false,
"properties": {
"changed_resources": {
"items": {
"$ref": "#/components/schemas/ExternalIdentity"
},
"maxItems": 100,
"title": "Changed Resources",
"type": "array"
},
"code": {
"enum": [
"observed",
"applied",
"unsupported",
"precondition_failed",
"provider_failed",
"cancelled",
"ambiguous",
"reconciled"
],
"title": "Code",
"type": "string"
},
"external_effects_may_continue": {
"default": false,
"title": "External Effects May Continue",
"type": "boolean"
}
},
"required": [
"code"
],
"title": "SafeDeploymentReceipt",
"type": "object"
}SafeInteger
{
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"type": "integer"
}SafeReason
{
"pattern": "^[a-z][a-z0-9_]{0,63}$",
"type": "string"
}ScheduleOccurrence
{
"additionalProperties": false,
"properties": {
"environment_id": {
"format": "uuid",
"title": "Environment Id",
"type": "string"
},
"instant": {
"format": "date-time",
"title": "Instant",
"type": "string"
},
"kind": {
"enum": [
"started",
"skipped"
],
"title": "Kind",
"type": "string"
},
"observed_at": {
"format": "date-time",
"title": "Observed At",
"type": "string"
},
"project_id": {
"format": "uuid",
"title": "Project Id",
"type": "string"
},
"reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason"
},
"revision": {
"title": "Revision",
"type": "integer"
},
"run_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Run Id"
},
"schedule_id": {
"format": "uuid",
"title": "Schedule Id",
"type": "string"
},
"sequence": {
"title": "Sequence",
"type": "integer"
},
"tenant_id": {
"format": "uuid",
"title": "Tenant Id",
"type": "string"
},
"through": {
"format": "date-time",
"title": "Through",
"type": "string"
}
},
"required": [
"sequence",
"tenant_id",
"project_id",
"environment_id",
"schedule_id",
"revision",
"instant",
"through",
"observed_at",
"kind",
"reason",
"run_id"
],
"title": "ScheduleOccurrence",
"type": "object"
}ScheduleRequest
{
"additionalProperties": false,
"properties": {
"activation_id": {
"format": "uuid",
"title": "Activation Id",
"type": "string"
},
"cron": {
"maxLength": 256,
"title": "Cron",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"input": {
"$ref": "#/components/schemas/JsonData-Input",
"default": null
},
"missed_policy": {
"const": "skip",
"default": "skip",
"title": "Missed Policy",
"type": "string"
},
"timezone": {
"const": "UTC",
"default": "UTC",
"title": "Timezone",
"type": "string"
}
},
"required": [
"cron",
"activation_id"
],
"title": "ScheduleRequest",
"type": "object"
}ScheduleView
{
"additionalProperties": false,
"properties": {
"activation_id": {
"format": "uuid",
"title": "Activation Id",
"type": "string"
},
"blocked_reason": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Blocked Reason"
},
"cron": {
"maxLength": 256,
"title": "Cron",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"input": {
"$ref": "#/components/schemas/JsonData-Output",
"default": null
},
"missed_policy": {
"const": "skip",
"default": "skip",
"title": "Missed Policy",
"type": "string"
},
"next_due_at": {
"format": "date-time",
"title": "Next Due At",
"type": "string"
},
"principal_id": {
"format": "uuid",
"title": "Principal Id",
"type": "string"
},
"revision": {
"title": "Revision",
"type": "integer"
},
"status": {
"enum": [
"enabled",
"disabled",
"blocked",
"deleted"
],
"title": "Status",
"type": "string"
},
"timezone": {
"const": "UTC",
"default": "UTC",
"title": "Timezone",
"type": "string"
}
},
"required": [
"cron",
"activation_id",
"revision",
"principal_id",
"status",
"next_due_at"
],
"title": "ScheduleView",
"type": "object"
}Scope
{
"additionalProperties": false,
"properties": {
"environment_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Environment Id"
},
"project_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Project Id"
},
"tenant_id": {
"format": "uuid",
"title": "Tenant Id",
"type": "string"
}
},
"required": [
"tenant_id"
],
"title": "Scope",
"type": "object"
}SemVer
{
"allOf": [
{
"$ref": "#/components/schemas/UnicodeString_6__PydanticGeneralMetadata_pattern______1-9__0-9____1-9__0-9____1-9__0-9______-______1-9__0-9____0-9___A-Za-z-__0-9A-Za-z-____1-9__0-9____0-9___A-Za-z-__0-9A-Za-z-__________0-9A-Za-z-_____0-9A-Za-z-_________"
},
{
"pattern": "^(?:0|[1-9][0-9]*)\\.(?:0|[1-9][0-9]*)\\.(?:0|[1-9][0-9]*)(?:-(?:(?:0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*))(?:\\.(?:0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$",
"type": "string"
}
]
}SideEffect
{
"enum": [
"read_only",
"idempotent",
"idempotency_key",
"non_idempotent"
],
"type": "string"
}SignInOption
{
"additionalProperties": false,
"description": "One identity provider and public login client offered to people.",
"properties": {
"allow_loopback_http": {
"default": false,
"title": "Allow Loopback Http",
"type": "boolean"
},
"client_id": {
"maxLength": 200,
"minLength": 1,
"title": "Client Id",
"type": "string"
},
"display_name": {
"maxLength": 100,
"minLength": 1,
"title": "Display Name",
"type": "string"
},
"flows": {
"items": {
"enum": [
"browser",
"device"
],
"type": "string"
},
"maxItems": 2,
"minItems": 1,
"title": "Flows",
"type": "array"
},
"issuer": {
"maxLength": 2048,
"minLength": 1,
"title": "Issuer",
"type": "string"
},
"provider_id": {
"maxLength": 200,
"minLength": 1,
"title": "Provider Id",
"type": "string"
},
"require_refresh_rotation": {
"default": true,
"title": "Require Refresh Rotation",
"type": "boolean"
},
"scopes": {
"items": {
"type": "string"
},
"maxItems": 32,
"minItems": 1,
"title": "Scopes",
"type": "array"
},
"trusted_endpoint_origins": {
"items": {
"type": "string"
},
"maxItems": 8,
"title": "Trusted Endpoint Origins",
"type": "array"
}
},
"required": [
"provider_id",
"display_name",
"issuer",
"client_id",
"scopes"
],
"title": "SignInOption",
"type": "object"
}SignalNode
{
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/NodeId"
},
"kind": {
"const": "signal",
"title": "Kind",
"type": "string"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"path": {
"$ref": "#/components/schemas/JsonPointer"
},
"schemaRef": {
"$ref": "#/components/schemas/firefly_weave__compiler__ir__Digest"
},
"scope": {
"items": {
"$ref": "#/components/schemas/UnicodeString"
},
"maxItems": 64,
"title": "Scope",
"type": "array"
},
"timeoutSeconds": {
"$ref": "#/components/schemas/PositiveInt"
}
},
"required": [
"id",
"scope",
"path",
"kind",
"name",
"timeoutSeconds",
"schemaRef"
],
"title": "SignalNode",
"type": "object"
}SignalReceipt
{
"additionalProperties": false,
"properties": {
"accepted_at": {
"format": "date-time",
"title": "Accepted At",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"request_hash": {
"title": "Request Hash",
"type": "string"
}
},
"required": [
"id",
"request_hash",
"accepted_at"
],
"title": "SignalReceipt",
"type": "object"
}SignalRequest
{
"additionalProperties": false,
"properties": {
"eventId": {
"maxLength": 200,
"minLength": 1,
"title": "Eventid",
"type": "string"
},
"name": {
"maxLength": 100,
"minLength": 1,
"title": "Name",
"type": "string"
},
"payload": {
"$ref": "#/components/schemas/JsonData-Input"
}
},
"required": [
"eventId",
"name",
"payload"
],
"title": "SignalRequest",
"type": "object"
}SignalStep-Input
{
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "signal",
"title": "Kind",
"type": "string"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"payloadSchema": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"timeoutSeconds": {
"$ref": "#/components/schemas/PositiveInt"
}
},
"required": [
"id",
"kind",
"name",
"timeoutSeconds",
"payloadSchema"
],
"title": "SignalStep",
"type": "object"
}SignalStep-Output
{
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "signal",
"title": "Kind",
"type": "string"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"payloadSchema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"timeoutSeconds": {
"$ref": "#/components/schemas/PositiveInt"
}
},
"required": [
"id",
"kind",
"name",
"timeoutSeconds",
"payloadSchema"
],
"title": "SignalStep",
"type": "object"
}SourceBinding
{
"additionalProperties": false,
"properties": {
"connection_revision_id": {
"format": "uuid",
"title": "Connection Revision Id",
"type": "string"
},
"generation": {
"default": 1,
"title": "Generation",
"type": "integer"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"principal_id": {
"format": "uuid",
"title": "Principal Id",
"type": "string"
},
"revoked": {
"default": false,
"title": "Revoked",
"type": "boolean"
},
"source_fingerprint": {
"title": "Source Fingerprint",
"type": "string"
},
"source_id": {
"format": "uuid",
"title": "Source Id",
"type": "string"
},
"source_kind": {
"enum": [
"kafka-trigger",
"outbox-subscription",
"provider-source"
],
"title": "Source Kind",
"type": "string"
}
},
"required": [
"id",
"connection_revision_id",
"source_kind",
"source_id",
"principal_id",
"source_fingerprint"
],
"title": "SourceBinding",
"type": "object"
}SourceExport
{
"additionalProperties": false,
"properties": {
"envelope": {
"$ref": "#/components/schemas/ArtifactEnvelope"
},
"format": {
"enum": [
"yaml",
"json"
],
"title": "Format",
"type": "string"
},
"source": {
"title": "Source",
"type": "string"
},
"source_hash": {
"title": "Source Hash",
"type": "string"
}
},
"required": [
"source",
"format",
"source_hash",
"envelope"
],
"title": "SourceExport",
"type": "object"
}SourceRange
{
"additionalProperties": false,
"properties": {
"column": {
"$ref": "#/components/schemas/PositiveInt"
},
"endColumn": {
"anyOf": [
{
"$ref": "#/components/schemas/PositiveInt"
},
{
"type": "null"
}
],
"default": null
},
"endLine": {
"anyOf": [
{
"$ref": "#/components/schemas/PositiveInt"
},
{
"type": "null"
}
],
"default": null
},
"file": {
"anyOf": [
{
"$ref": "#/components/schemas/UnicodeString"
},
{
"type": "null"
}
],
"default": null
},
"line": {
"$ref": "#/components/schemas/PositiveInt"
}
},
"required": [
"line",
"column"
],
"title": "SourceRange",
"type": "object"
}SourceReference
{
"additionalProperties": false,
"properties": {
"format": {
"enum": [
"json",
"yaml"
],
"title": "Format",
"type": "string"
},
"scope": {
"$ref": "#/components/schemas/Scope"
},
"source_hash": {
"$ref": "#/components/schemas/firefly_weave__contracts__catalog__Digest"
},
"version_id": {
"format": "uuid",
"title": "Version Id",
"type": "string"
}
},
"required": [
"scope",
"version_id",
"source_hash",
"format"
],
"title": "SourceReference",
"type": "object"
}StartNode
{
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/NodeId"
},
"kind": {
"const": "start",
"title": "Kind",
"type": "string"
},
"path": {
"$ref": "#/components/schemas/JsonPointer"
},
"scope": {
"items": {
"$ref": "#/components/schemas/UnicodeString"
},
"maxItems": 64,
"title": "Scope",
"type": "array"
}
},
"required": [
"id",
"scope",
"path",
"kind"
],
"title": "StartNode",
"type": "object"
}StartRunRequest
{
"additionalProperties": false,
"properties": {
"activation_id": {
"format": "uuid",
"title": "Activation Id",
"type": "string"
},
"business_key": {
"anyOf": [
{
"maxLength": 200,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Business Key"
},
"correlation_key": {
"anyOf": [
{
"maxLength": 200,
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Correlation Key"
},
"input": {
"$ref": "#/components/schemas/JsonData-Input"
}
},
"required": [
"activation_id",
"input"
],
"title": "StartRunRequest",
"type": "object"
}Status
{
"enum": [
"sent",
"delivered",
"read",
"failed",
"deleted"
],
"type": "string"
}StatusFilter
{
"items": {
"$ref": "#/components/schemas/RunStatus"
},
"maxItems": 8,
"type": "array"
}Step-Input
{
"discriminator": {
"mapping": {
"action": "#/components/schemas/ActionStep-Input",
"callWorkflow": "#/components/schemas/CallWorkflowStep-Input",
"decisionTable": "#/components/schemas/DecisionTableStep-Input",
"fail": "#/components/schemas/FailStep",
"forEach": "#/components/schemas/ForEachStep-Input",
"humanTask": "#/components/schemas/HumanTaskStep-Input",
"llm": "#/components/schemas/LLMStep-Input",
"parallel": "#/components/schemas/ParallelStep-Input",
"signal": "#/components/schemas/SignalStep-Input",
"switch": "#/components/schemas/SwitchStep-Input",
"transform": "#/components/schemas/TransformStep-Input",
"wait": "#/components/schemas/WaitStep"
},
"propertyName": "kind"
},
"oneOf": [
{
"$ref": "#/components/schemas/ActionStep-Input"
},
{
"$ref": "#/components/schemas/LLMStep-Input"
},
{
"$ref": "#/components/schemas/TransformStep-Input"
},
{
"$ref": "#/components/schemas/DecisionTableStep-Input"
},
{
"$ref": "#/components/schemas/SwitchStep-Input"
},
{
"$ref": "#/components/schemas/ParallelStep-Input"
},
{
"$ref": "#/components/schemas/WaitStep"
},
{
"$ref": "#/components/schemas/SignalStep-Input"
},
{
"$ref": "#/components/schemas/HumanTaskStep-Input"
},
{
"$ref": "#/components/schemas/FailStep"
},
{
"$ref": "#/components/schemas/ForEachStep-Input"
},
{
"$ref": "#/components/schemas/CallWorkflowStep-Input"
}
]
}Step-Output
{
"discriminator": {
"mapping": {
"action": "#/components/schemas/ActionStep-Output",
"callWorkflow": "#/components/schemas/CallWorkflowStep-Output",
"decisionTable": "#/components/schemas/DecisionTableStep-Output",
"fail": "#/components/schemas/FailStep",
"forEach": "#/components/schemas/ForEachStep-Output",
"humanTask": "#/components/schemas/HumanTaskStep-Output",
"llm": "#/components/schemas/LLMStep-Output",
"parallel": "#/components/schemas/ParallelStep-Output",
"signal": "#/components/schemas/SignalStep-Output",
"switch": "#/components/schemas/SwitchStep-Output",
"transform": "#/components/schemas/TransformStep-Output",
"wait": "#/components/schemas/WaitStep"
},
"propertyName": "kind"
},
"oneOf": [
{
"$ref": "#/components/schemas/ActionStep-Output"
},
{
"$ref": "#/components/schemas/LLMStep-Output"
},
{
"$ref": "#/components/schemas/TransformStep-Output"
},
{
"$ref": "#/components/schemas/DecisionTableStep-Output"
},
{
"$ref": "#/components/schemas/SwitchStep-Output"
},
{
"$ref": "#/components/schemas/ParallelStep-Output"
},
{
"$ref": "#/components/schemas/WaitStep"
},
{
"$ref": "#/components/schemas/SignalStep-Output"
},
{
"$ref": "#/components/schemas/HumanTaskStep-Output"
},
{
"$ref": "#/components/schemas/FailStep"
},
{
"$ref": "#/components/schemas/ForEachStep-Output"
},
{
"$ref": "#/components/schemas/CallWorkflowStep-Output"
}
]
}StepFact
{
"additionalProperties": false,
"description": "One step instance of a run. With `include=output`, an output that cannot be returned is named in\n`omissions` with its reason, and a returned output makes the item a `StepFactWithOutput`.",
"properties": {
"attempts": {
"$ref": "#/components/schemas/Count"
},
"child_run_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Child Run Id"
},
"duration_ms": {
"anyOf": [
{
"$ref": "#/components/schemas/Milliseconds"
},
{
"type": "null"
}
]
},
"ended_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Ended At"
},
"error_code": {
"anyOf": [
{
"$ref": "#/components/schemas/ErrorCode"
},
{
"type": "null"
}
]
},
"instance_key": {
"maxLength": 512,
"pattern": "^(?:@?[A-Za-z0-9][A-Za-z0-9_.:@-]*(?:\\[(?:0|[1-9][0-9]{0,14}|[1-8][0-9]{15}|900[0-6][0-9]{12}|90070[0-9]{11}|90071[0-8][0-9]{10}|900719[0-8][0-9]{9}|9007199[0-1][0-9]{8}|90071992[0-4][0-9]{7}|900719925[0-3][0-9]{6}|9007199254[0-6][0-9]{5}|90071992547[0-3][0-9]{4}|9007199254740[0-8][0-9]{2}|90071992547409[0-8][0-9]|9007199254740990|9007199254740991)\\])*(?:#[A-Za-z0-9]+(?:\\.[A-Za-z0-9]+)*)?(?:~(?:[1-9][0-9]{0,14}|[1-8][0-9]{15}|900[0-6][0-9]{12}|90070[0-9]{11}|90071[0-8][0-9]{10}|900719[0-8][0-9]{9}|9007199[0-1][0-9]{8}|90071992[0-4][0-9]{7}|900719925[0-3][0-9]{6}|9007199254[0-6][0-9]{5}|90071992547[0-3][0-9]{4}|9007199254740[0-8][0-9]{2}|90071992547409[0-8][0-9]|9007199254740990|9007199254740991))?)?$",
"title": "Instance Key",
"type": "string"
},
"iteration": {
"items": {
"$ref": "#/components/schemas/Count"
},
"maxItems": 64,
"title": "Iteration",
"type": "array"
},
"kind": {
"$ref": "#/components/schemas/StepKind"
},
"log_entries": {
"$ref": "#/components/schemas/Count"
},
"node_id": {
"$ref": "#/components/schemas/ResourceName"
},
"omissions": {
"items": {
"$ref": "#/components/schemas/Omission"
},
"maxItems": 8,
"title": "Omissions",
"type": "array"
},
"queue_wait_ms": {
"anyOf": [
{
"$ref": "#/components/schemas/Milliseconds"
},
{
"type": "null"
}
]
},
"scheduled_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Scheduled At"
},
"started_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Started At"
},
"status": {
"$ref": "#/components/schemas/StepStatus"
},
"worker_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Worker Id"
}
},
"required": [
"node_id",
"instance_key",
"iteration",
"kind",
"status",
"scheduled_at",
"started_at",
"ended_at",
"duration_ms",
"queue_wait_ms",
"attempts",
"worker_id",
"error_code",
"child_run_id",
"log_entries"
],
"title": "StepFact",
"type": "object"
}StepFactPage
{
"additionalProperties": false,
"properties": {
"complete": {
"title": "Complete",
"type": "boolean"
},
"items": {
"items": {
"anyOf": [
{
"$ref": "#/components/schemas/StepFactWithOutput"
},
{
"$ref": "#/components/schemas/StepFact"
}
]
},
"maxItems": 500,
"title": "Items",
"type": "array"
},
"next_cursor": {
"anyOf": [
{
"$ref": "#/components/schemas/Cursor"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"items",
"complete"
],
"title": "StepFactPage",
"type": "object"
}StepFactWithOutput
{
"additionalProperties": false,
"description": "A step instance whose recorded output passed the RunView classification rules (may be null).",
"properties": {
"attempts": {
"$ref": "#/components/schemas/Count"
},
"child_run_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Child Run Id"
},
"duration_ms": {
"anyOf": [
{
"$ref": "#/components/schemas/Milliseconds"
},
{
"type": "null"
}
]
},
"ended_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Ended At"
},
"error_code": {
"anyOf": [
{
"$ref": "#/components/schemas/ErrorCode"
},
{
"type": "null"
}
]
},
"instance_key": {
"maxLength": 512,
"pattern": "^(?:@?[A-Za-z0-9][A-Za-z0-9_.:@-]*(?:\\[(?:0|[1-9][0-9]{0,14}|[1-8][0-9]{15}|900[0-6][0-9]{12}|90070[0-9]{11}|90071[0-8][0-9]{10}|900719[0-8][0-9]{9}|9007199[0-1][0-9]{8}|90071992[0-4][0-9]{7}|900719925[0-3][0-9]{6}|9007199254[0-6][0-9]{5}|90071992547[0-3][0-9]{4}|9007199254740[0-8][0-9]{2}|90071992547409[0-8][0-9]|9007199254740990|9007199254740991)\\])*(?:#[A-Za-z0-9]+(?:\\.[A-Za-z0-9]+)*)?(?:~(?:[1-9][0-9]{0,14}|[1-8][0-9]{15}|900[0-6][0-9]{12}|90070[0-9]{11}|90071[0-8][0-9]{10}|900719[0-8][0-9]{9}|9007199[0-1][0-9]{8}|90071992[0-4][0-9]{7}|900719925[0-3][0-9]{6}|9007199254[0-6][0-9]{5}|90071992547[0-3][0-9]{4}|9007199254740[0-8][0-9]{2}|90071992547409[0-8][0-9]|9007199254740990|9007199254740991))?)?$",
"title": "Instance Key",
"type": "string"
},
"iteration": {
"items": {
"$ref": "#/components/schemas/Count"
},
"maxItems": 64,
"title": "Iteration",
"type": "array"
},
"kind": {
"$ref": "#/components/schemas/StepKind"
},
"log_entries": {
"$ref": "#/components/schemas/Count"
},
"node_id": {
"$ref": "#/components/schemas/ResourceName"
},
"omissions": {
"items": {
"$ref": "#/components/schemas/Omission"
},
"maxItems": 8,
"title": "Omissions",
"type": "array"
},
"output": {
"$ref": "#/components/schemas/JsonData-Output"
},
"queue_wait_ms": {
"anyOf": [
{
"$ref": "#/components/schemas/Milliseconds"
},
{
"type": "null"
}
]
},
"scheduled_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Scheduled At"
},
"started_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Started At"
},
"status": {
"$ref": "#/components/schemas/StepStatus"
},
"worker_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"title": "Worker Id"
}
},
"required": [
"node_id",
"instance_key",
"iteration",
"kind",
"status",
"scheduled_at",
"started_at",
"ended_at",
"duration_ms",
"queue_wait_ms",
"attempts",
"worker_id",
"error_code",
"child_run_id",
"log_entries",
"output"
],
"title": "StepFactWithOutput",
"type": "object"
}StepKind
{
"enum": [
"action",
"llm",
"transform",
"decisionTable",
"switch",
"parallel",
"wait",
"signal",
"humanTask",
"fail",
"forEach",
"callWorkflow",
"agent"
],
"type": "string"
}StepStatus
{
"enum": [
"scheduled",
"running",
"waiting",
"succeeded",
"failed",
"cancelled",
"timed_out"
],
"type": "string"
}StudioMark
{
"enum": [
"ready",
"pending"
],
"type": "string"
}Subscription
{
"additionalProperties": false,
"properties": {
"active": {
"default": true,
"title": "Active",
"type": "boolean"
},
"binding_id": {
"format": "uuid",
"title": "Binding Id",
"type": "string"
},
"connection_revision_id": {
"format": "uuid",
"title": "Connection Revision Id",
"type": "string"
},
"event_types": {
"items": {
"enum": [
"run.transition",
"definition.published",
"activation.activated",
"activation.retired"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"title": "Event Types",
"type": "array"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"path": {
"maxLength": 2048,
"title": "Path",
"type": "string"
},
"principal_id": {
"format": "uuid",
"title": "Principal Id",
"type": "string"
},
"revision": {
"title": "Revision",
"type": "integer"
},
"signing_slot": {
"$ref": "#/components/schemas/ResourceName"
},
"statuses": {
"default": [
200,
202,
204
],
"items": {
"type": "integer"
},
"title": "Statuses",
"type": "array"
}
},
"required": [
"name",
"connection_revision_id",
"signing_slot",
"path",
"event_types",
"id",
"revision",
"binding_id",
"principal_id"
],
"title": "Subscription",
"type": "object"
}SubscriptionRequest
{
"additionalProperties": false,
"properties": {
"connection_revision_id": {
"format": "uuid",
"title": "Connection Revision Id",
"type": "string"
},
"event_types": {
"items": {
"enum": [
"run.transition",
"definition.published",
"activation.activated",
"activation.retired"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"title": "Event Types",
"type": "array"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"path": {
"maxLength": 2048,
"title": "Path",
"type": "string"
},
"signing_slot": {
"$ref": "#/components/schemas/ResourceName"
},
"statuses": {
"default": [
200,
202,
204
],
"items": {
"type": "integer"
},
"title": "Statuses",
"type": "array"
}
},
"required": [
"name",
"connection_revision_id",
"signing_slot",
"path",
"event_types"
],
"title": "SubscriptionRequest",
"type": "object"
}SuggestedEdit
{
"additionalProperties": false,
"properties": {
"path": {
"$ref": "#/components/schemas/JsonPointer"
},
"value": {
"$ref": "#/components/schemas/JsonData-Output"
}
},
"required": [
"path",
"value"
],
"title": "SuggestedEdit",
"type": "object"
}SummaryLimit
{
"maximum": 100,
"minimum": 1,
"type": "integer"
}SwitchCase-Input
{
"additionalProperties": false,
"properties": {
"output": {
"$ref": "#/components/schemas/Expression-Input"
},
"steps": {
"items": {
"$ref": "#/components/schemas/Step-Input"
},
"title": "Steps",
"type": "array"
},
"when": {
"$ref": "#/components/schemas/Expression-Input"
}
},
"required": [
"steps",
"output",
"when"
],
"title": "SwitchCase",
"type": "object"
}SwitchNode
{
"additionalProperties": false,
"properties": {
"cases": {
"items": {
"$ref": "#/components/schemas/firefly_weave__compiler__ir__SwitchCase"
},
"minItems": 1,
"title": "Cases",
"type": "array"
},
"default": {
"$ref": "#/components/schemas/NodeId"
},
"id": {
"$ref": "#/components/schemas/NodeId"
},
"join": {
"$ref": "#/components/schemas/NodeId"
},
"kind": {
"const": "switch",
"title": "Kind",
"type": "string"
},
"path": {
"$ref": "#/components/schemas/JsonPointer"
},
"scope": {
"items": {
"$ref": "#/components/schemas/UnicodeString"
},
"maxItems": 64,
"title": "Scope",
"type": "array"
}
},
"required": [
"id",
"scope",
"path",
"kind",
"cases",
"default",
"join"
],
"title": "SwitchNode",
"type": "object"
}SwitchStep-Input
{
"additionalProperties": false,
"properties": {
"cases": {
"items": {
"$ref": "#/components/schemas/SwitchCase-Input"
},
"minItems": 1,
"title": "Cases",
"type": "array"
},
"default": {
"$ref": "#/components/schemas/Branch-Input"
},
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "switch",
"title": "Kind",
"type": "string"
}
},
"required": [
"id",
"kind",
"cases",
"default"
],
"title": "SwitchStep",
"type": "object"
}SwitchStep-Output
{
"additionalProperties": false,
"properties": {
"cases": {
"items": {
"$ref": "#/components/schemas/firefly_weave__contracts__definitions__SwitchCase-Output"
},
"minItems": 1,
"title": "Cases",
"type": "array"
},
"default": {
"$ref": "#/components/schemas/Branch-Output"
},
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "switch",
"title": "Kind",
"type": "string"
}
},
"required": [
"id",
"kind",
"cases",
"default"
],
"title": "SwitchStep",
"type": "object"
}TargetRequest
{
"additionalProperties": false,
"properties": {
"adapter": {
"$ref": "#/components/schemas/AdapterKind"
},
"boundary": {
"$ref": "#/components/schemas/DeploymentName"
},
"capabilities": {
"items": {
"$ref": "#/components/schemas/DeploymentCapability"
},
"maxItems": 5,
"minItems": 1,
"title": "Capabilities",
"type": "array"
},
"external_identity": {
"$ref": "#/components/schemas/ExternalIdentity"
},
"name": {
"$ref": "#/components/schemas/DeploymentName"
},
"runner_principal_id": {
"format": "uuid",
"title": "Runner Principal Id",
"type": "string"
}
},
"required": [
"name",
"adapter",
"external_identity",
"boundary",
"runner_principal_id",
"capabilities"
],
"title": "TargetRequest",
"type": "object"
}TargetUpdate
{
"additionalProperties": false,
"properties": {
"capabilities": {
"items": {
"$ref": "#/components/schemas/DeploymentCapability"
},
"maxItems": 5,
"minItems": 1,
"title": "Capabilities",
"type": "array"
},
"disabled": {
"default": false,
"title": "Disabled",
"type": "boolean"
},
"runner_principal_id": {
"format": "uuid",
"title": "Runner Principal Id",
"type": "string"
}
},
"required": [
"runner_principal_id",
"capabilities"
],
"title": "TargetUpdate",
"type": "object"
}TaskCapability-Input
{
"additionalProperties": false,
"description": "Published task contract, independent of worker instance/release readiness.",
"properties": {
"inputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"outputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"sideEffect": {
"$ref": "#/components/schemas/SideEffect"
},
"taskType": {
"$ref": "#/components/schemas/ResourceName"
},
"taskVersion": {
"$ref": "#/components/schemas/SemVer"
},
"timeoutSeconds": {
"$ref": "#/components/schemas/PositiveInt"
}
},
"required": [
"taskType",
"taskVersion",
"inputSchema",
"outputSchema",
"sideEffect",
"timeoutSeconds"
],
"title": "TaskCapability",
"type": "object"
}TaskCapability-Output
{
"additionalProperties": false,
"description": "Published task contract, independent of worker instance/release readiness.",
"properties": {
"inputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"outputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"sideEffect": {
"$ref": "#/components/schemas/SideEffect"
},
"taskType": {
"$ref": "#/components/schemas/ResourceName"
},
"taskVersion": {
"$ref": "#/components/schemas/SemVer"
},
"timeoutSeconds": {
"$ref": "#/components/schemas/PositiveInt"
}
},
"required": [
"taskType",
"taskVersion",
"inputSchema",
"outputSchema",
"sideEffect",
"timeoutSeconds"
],
"title": "TaskCapability",
"type": "object"
}TaskConnectionContext
{
"additionalProperties": false,
"description": "Public metadata of the connection pinned to this task; no secret handles or values.",
"properties": {
"allowed_destinations": {
"items": {
"type": "string"
},
"title": "Allowed Destinations",
"type": "array"
},
"config": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"connector": {
"title": "Connector",
"type": "string"
},
"revision_id": {
"format": "uuid",
"title": "Revision Id",
"type": "string"
},
"secret_slots": {
"items": {
"$ref": "#/components/schemas/ResourceName"
},
"title": "Secret Slots",
"type": "array"
}
},
"required": [
"revision_id",
"connector",
"config",
"allowed_destinations",
"secret_slots"
],
"title": "TaskConnectionContext",
"type": "object"
}TaskError
{
"additionalProperties": false,
"properties": {
"code": {
"pattern": "^[A-Z][A-Z0-9_-]{0,63}$",
"title": "Code",
"type": "string"
},
"completion_id": {
"format": "uuid",
"title": "Completion Id",
"type": "string"
},
"outcome": {
"default": "unknown",
"enum": [
"not_started",
"failed",
"unknown"
],
"title": "Outcome",
"type": "string"
}
},
"required": [
"completion_id",
"code"
],
"title": "TaskError",
"type": "object"
}TaskExecutionContext
{
"additionalProperties": false,
"properties": {
"connection": {
"anyOf": [
{
"$ref": "#/components/schemas/TaskConnectionContext"
},
{
"type": "null"
}
]
},
"expires_at": {
"format": "date-time",
"title": "Expires At",
"type": "string"
}
},
"required": [
"connection",
"expires_at"
],
"title": "TaskExecutionContext",
"type": "object"
}TaskGroup
{
"additionalProperties": false,
"properties": {
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"member_ids": {
"items": {
"format": "uuid",
"type": "string"
},
"title": "Member Ids",
"type": "array"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"revision": {
"minimum": 1,
"title": "Revision",
"type": "integer"
}
},
"required": [
"id",
"name",
"revision",
"member_ids"
],
"title": "TaskGroup",
"type": "object"
}TaskGroupRequest
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"default": 0,
"minimum": 0,
"title": "Expected Revision",
"type": "integer"
},
"member_ids": {
"items": {
"format": "uuid",
"type": "string"
},
"maxItems": 256,
"title": "Member Ids",
"type": "array"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
}
},
"required": [
"name"
],
"title": "TaskGroupRequest",
"type": "object"
}TaskLease
{
"additionalProperties": false,
"properties": {
"capability": {
"title": "Capability",
"type": "string"
},
"deadline": {
"format": "date-time",
"title": "Deadline",
"type": "string"
},
"expires_at": {
"format": "date-time",
"title": "Expires At",
"type": "string"
},
"input": {
"$ref": "#/components/schemas/JsonData-Output"
},
"operation_key": {
"title": "Operation Key",
"type": "string"
},
"proof": {
"$ref": "#/components/schemas/LeaseProof"
},
"worker_release_id": {
"format": "uuid",
"title": "Worker Release Id",
"type": "string"
}
},
"required": [
"proof",
"input",
"operation_key",
"deadline",
"expires_at",
"capability",
"worker_release_id"
],
"title": "TaskLease",
"type": "object"
}TeamsReactivateRequest
{
"additionalProperties": false,
"properties": {
"expected_generation": {
"minimum": 1,
"title": "Expected Generation",
"type": "integer"
},
"request_id": {
"format": "uuid",
"title": "Request Id",
"type": "string"
},
"source_id": {
"format": "uuid",
"title": "Source Id",
"type": "string"
}
},
"required": [
"expected_generation",
"source_id",
"request_id"
],
"title": "TeamsReactivateRequest",
"type": "object"
}TeamsReference
{
"additionalProperties": false,
"properties": {
"account_id": {
"title": "Account Id",
"type": "string"
},
"bot_id": {
"title": "Bot Id",
"type": "string"
},
"connection_revision_id": {
"format": "uuid",
"title": "Connection Revision Id",
"type": "string"
},
"conversation_id": {
"title": "Conversation Id",
"type": "string"
},
"generation": {
"minimum": 1,
"title": "Generation",
"type": "integer"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"service_url": {
"title": "Service Url",
"type": "string"
},
"source_id": {
"format": "uuid",
"title": "Source Id",
"type": "string"
},
"state": {
"enum": [
"active",
"revoked"
],
"title": "State",
"type": "string"
},
"tenant_id": {
"title": "Tenant Id",
"type": "string"
},
"user_id": {
"title": "User Id",
"type": "string"
}
},
"required": [
"id",
"source_id",
"connection_revision_id",
"generation",
"state",
"service_url",
"conversation_id",
"bot_id",
"user_id",
"account_id",
"tenant_id"
],
"title": "TeamsReference",
"type": "object"
}TeamsRevokeRequest
{
"additionalProperties": false,
"properties": {
"expected_generation": {
"minimum": 1,
"title": "Expected Generation",
"type": "integer"
}
},
"required": [
"expected_generation"
],
"title": "TeamsRevokeRequest",
"type": "object"
}TransformNode
{
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/NodeId"
},
"kind": {
"const": "transform",
"title": "Kind",
"type": "string"
},
"path": {
"$ref": "#/components/schemas/JsonPointer"
},
"scope": {
"items": {
"$ref": "#/components/schemas/UnicodeString"
},
"maxItems": 64,
"title": "Scope",
"type": "array"
},
"value": {
"$ref": "#/components/schemas/Expression-Output"
}
},
"required": [
"id",
"scope",
"path",
"kind",
"value"
],
"title": "TransformNode",
"type": "object"
}TransformStep-Input
{
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "transform",
"title": "Kind",
"type": "string"
},
"value": {
"$ref": "#/components/schemas/Expression-Input"
}
},
"required": [
"id",
"kind",
"value"
],
"title": "TransformStep",
"type": "object"
}TransformStep-Output
{
"additionalProperties": false,
"properties": {
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "transform",
"title": "Kind",
"type": "string"
},
"value": {
"$ref": "#/components/schemas/Expression-Output"
}
},
"required": [
"id",
"kind",
"value"
],
"title": "TransformStep",
"type": "object"
}TransportCapabilities
{
"additionalProperties": false,
"description": "Fixed request-body allowances and receive deadlines, separate from project quotas.",
"properties": {
"debug_bytes": {
"exclusiveMinimum": 0,
"title": "Debug Bytes",
"type": "integer"
},
"idle_seconds": {
"exclusiveMinimum": 0,
"title": "Idle Seconds",
"type": "number"
},
"json_bytes": {
"exclusiveMinimum": 0,
"title": "Json Bytes",
"type": "integer"
},
"raw_bytes": {
"exclusiveMinimum": 0,
"title": "Raw Bytes",
"type": "integer"
},
"total_seconds": {
"exclusiveMinimum": 0,
"title": "Total Seconds",
"type": "number"
}
},
"required": [
"json_bytes",
"debug_bytes",
"raw_bytes",
"idle_seconds",
"total_seconds"
],
"title": "TransportCapabilities",
"type": "object"
}Trigger
{
"additionalProperties": false,
"properties": {
"activation_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Activation Id"
},
"disabled": {
"default": false,
"title": "Disabled",
"type": "boolean"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"kind": {
"enum": [
"run",
"signal"
],
"title": "Kind",
"type": "string"
},
"max_body_bytes": {
"default": 1048576,
"maximum": 1048576,
"minimum": 1,
"title": "Max Body Bytes",
"type": "integer"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"payload_schema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"principal_id": {
"format": "uuid",
"title": "Principal Id",
"type": "string"
},
"run_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Run Id"
},
"secret_ref": {
"$ref": "#/components/schemas/ResourceName"
},
"signal": {
"anyOf": [
{
"$ref": "#/components/schemas/ResourceName"
},
{
"type": "null"
}
],
"default": null
},
"tolerance_seconds": {
"default": 300,
"maximum": 300,
"minimum": 1,
"title": "Tolerance Seconds",
"type": "integer"
}
},
"required": [
"name",
"kind",
"secret_ref",
"id",
"principal_id"
],
"title": "Trigger",
"type": "object"
}TriggerReceipt
{
"additionalProperties": false,
"properties": {
"event_id": {
"title": "Event Id",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"run_id": {
"format": "uuid",
"title": "Run Id",
"type": "string"
},
"signal_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Signal Id"
},
"trigger_id": {
"format": "uuid",
"title": "Trigger Id",
"type": "string"
}
},
"required": [
"id",
"trigger_id",
"event_id",
"run_id"
],
"title": "TriggerReceipt",
"type": "object"
}TriggerRequest
{
"additionalProperties": false,
"properties": {
"activation_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Activation Id"
},
"kind": {
"enum": [
"run",
"signal"
],
"title": "Kind",
"type": "string"
},
"max_body_bytes": {
"default": 1048576,
"maximum": 1048576,
"minimum": 1,
"title": "Max Body Bytes",
"type": "integer"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"payload_schema": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"run_id": {
"anyOf": [
{
"format": "uuid",
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Run Id"
},
"secret_ref": {
"$ref": "#/components/schemas/ResourceName"
},
"signal": {
"anyOf": [
{
"$ref": "#/components/schemas/ResourceName"
},
{
"type": "null"
}
],
"default": null
},
"tolerance_seconds": {
"default": 300,
"maximum": 300,
"minimum": 1,
"title": "Tolerance Seconds",
"type": "integer"
}
},
"required": [
"name",
"kind",
"secret_ref"
],
"title": "TriggerRequest",
"type": "object"
}UnicodeString
{
"type": "string"
}UnicodeString_6__PydanticGeneralMetadata_pattern______1-9__0-9____1-9__0-9____1-9__0-9______-______1-9__0-9____0-9___A-Za-z-__0-9A-Za-z-____1-9__0-9____0-9___A-Za-z-__0-9A-Za-z-__________0-9A-Za-z-_____0-9A-Za-z-_________
{
"type": "string"
}UnicodeString_6__PydanticGeneralMetadata_pattern_________________01________
{
"type": "string"
}UnicodeString_A-Z0-9_____A-Z0-9________
{
"type": "string"
}UnicodeString_A-Za-z0-9__-_____
{
"type": "string"
}UnicodeString_A-Za-z0-9__-______1-9__0-9____1-9__0-9____1-9__0-9______-______1-9__0-9____0-9___A-Za-z-__0-9A-Za-z-____1-9__0-9____0-9___A-Za-z-__0-9A-Za-z-__________0-9A-Za-z-_____0-9A-Za-z-_________
{
"type": "string"
}UnicodeString_A-Za-z0-9_____-__0_127____
{
"type": "string"
}UnicodeString_a-f0-9__64____
{
"type": "string"
}VersionExport
{
"additionalProperties": false,
"properties": {
"artifact": {
"$ref": "#/components/schemas/ArtifactEnvelope"
},
"definition_digest": {
"$ref": "#/components/schemas/firefly_weave__contracts__catalog__Digest"
},
"digest": {
"$ref": "#/components/schemas/firefly_weave__contracts__catalog__Digest"
},
"document": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"kind": {
"$ref": "#/components/schemas/DefinitionKind"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"retired": {
"default": false,
"title": "Retired",
"type": "boolean"
},
"sources": {
"items": {
"$ref": "#/components/schemas/SourceExport"
},
"title": "Sources",
"type": "array"
},
"version": {
"$ref": "#/components/schemas/SemVer"
}
},
"required": [
"id",
"kind",
"name",
"version",
"digest",
"definition_digest",
"document",
"artifact",
"sources"
],
"title": "VersionExport",
"type": "object"
}VersionView
{
"additionalProperties": false,
"properties": {
"definition_digest": {
"$ref": "#/components/schemas/firefly_weave__contracts__catalog__Digest"
},
"digest": {
"$ref": "#/components/schemas/firefly_weave__contracts__catalog__Digest"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"kind": {
"$ref": "#/components/schemas/DefinitionKind"
},
"name": {
"$ref": "#/components/schemas/ResourceName"
},
"retired": {
"default": false,
"title": "Retired",
"type": "boolean"
},
"version": {
"$ref": "#/components/schemas/SemVer"
}
},
"required": [
"id",
"kind",
"name",
"version",
"digest",
"definition_digest"
],
"title": "VersionView",
"type": "object"
}VersionedReference
{
"allOf": [
{
"$ref": "#/components/schemas/UnicodeString_A-Za-z0-9__-______1-9__0-9____1-9__0-9____1-9__0-9______-______1-9__0-9____0-9___A-Za-z-__0-9A-Za-z-____1-9__0-9____0-9___A-Za-z-__0-9A-Za-z-__________0-9A-Za-z-_____0-9A-Za-z-_________"
},
{
"pattern": "^[A-Za-z0-9][A-Za-z0-9_.-]*@(?:0|[1-9][0-9]*)\\.(?:0|[1-9][0-9]*)\\.(?:0|[1-9][0-9]*)(?:-(?:(?:0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*))(?:\\.(?:0|[1-9][0-9]*|[0-9]*[A-Za-z-][0-9A-Za-z-]*))*)?(?:\\+[0-9A-Za-z-]+(?:\\.[0-9A-Za-z-]+)*)?$",
"type": "string"
}
]
}WaitNode
{
"additionalProperties": false,
"properties": {
"durationSeconds": {
"$ref": "#/components/schemas/PositiveInt"
},
"id": {
"$ref": "#/components/schemas/NodeId"
},
"kind": {
"const": "wait",
"title": "Kind",
"type": "string"
},
"path": {
"$ref": "#/components/schemas/JsonPointer"
},
"scope": {
"items": {
"$ref": "#/components/schemas/UnicodeString"
},
"maxItems": 64,
"title": "Scope",
"type": "array"
}
},
"required": [
"id",
"scope",
"path",
"kind",
"durationSeconds"
],
"title": "WaitNode",
"type": "object"
}WaitStep
{
"additionalProperties": false,
"properties": {
"durationSeconds": {
"$ref": "#/components/schemas/PositiveInt"
},
"id": {
"$ref": "#/components/schemas/ResourceName"
},
"kind": {
"const": "wait",
"title": "Kind",
"type": "string"
}
},
"required": [
"id",
"kind",
"durationSeconds"
],
"title": "WaitStep",
"type": "object"
}WebhookEnvelope
{
"additionalProperties": false,
"properties": {
"eventId": {
"pattern": "^[A-Za-z0-9_.:-]{1,128}$",
"title": "Eventid",
"type": "string"
},
"payload": {
"$ref": "#/components/schemas/JsonData-Input"
}
},
"required": [
"eventId",
"payload"
],
"title": "WebhookEnvelope",
"type": "object"
}WhatsAppDeliveryState
{
"additionalProperties": false,
"properties": {
"deleted_seen": {
"title": "Deleted Seen",
"type": "boolean"
},
"fact_count": {
"minimum": 1,
"title": "Fact Count",
"type": "integer"
},
"failed_seen": {
"title": "Failed Seen",
"type": "boolean"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"installation_id": {
"title": "Installation Id",
"type": "string"
},
"message_id": {
"$ref": "#/components/schemas/MessageId"
},
"progress": {
"anyOf": [
{
"enum": [
"sent",
"delivered",
"read"
],
"type": "string"
},
{
"type": "null"
}
],
"title": "Progress"
},
"recipient": {
"$ref": "#/components/schemas/Phone"
}
},
"required": [
"id",
"installation_id",
"message_id",
"recipient",
"progress",
"failed_seen",
"deleted_seen",
"fact_count"
],
"title": "WhatsAppDeliveryState",
"type": "object"
}WhatsAppStatusFact
{
"additionalProperties": false,
"properties": {
"error_codes": {
"items": {
"type": "integer"
},
"maxItems": 10,
"title": "Error Codes",
"type": "array"
},
"facts_digest": {
"pattern": "^[a-f0-9]{64}$",
"title": "Facts Digest",
"type": "string"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"state_id": {
"format": "uuid",
"title": "State Id",
"type": "string"
},
"status": {
"$ref": "#/components/schemas/Status"
},
"timestamp": {
"pattern": "^(0|[1-9][0-9]{0,11})$",
"title": "Timestamp",
"type": "string"
}
},
"required": [
"id",
"state_id",
"status",
"timestamp",
"error_codes",
"facts_digest"
],
"title": "WhatsAppStatusFact",
"type": "object"
}WorkerControlRequest
{
"additionalProperties": false,
"properties": {
"expected_revision": {
"minimum": 1,
"title": "Expected Revision",
"type": "integer"
}
},
"required": [
"expected_revision"
],
"title": "WorkerControlRequest",
"type": "object"
}WorkerFileAccess
{
"additionalProperties": false,
"properties": {
"file_id": {
"format": "uuid",
"title": "File Id",
"type": "string"
},
"lease": {
"$ref": "#/components/schemas/LeaseProof"
}
},
"required": [
"lease",
"file_id"
],
"title": "WorkerFileAccess",
"type": "object"
}WorkerFileChunk
{
"additionalProperties": false,
"properties": {
"chunk": {
"$ref": "#/components/schemas/FileChunk"
},
"file_id": {
"format": "uuid",
"title": "File Id",
"type": "string"
},
"lease": {
"$ref": "#/components/schemas/LeaseProof"
}
},
"required": [
"lease",
"file_id",
"chunk"
],
"title": "WorkerFileChunk",
"type": "object"
}WorkerFileCreate
{
"additionalProperties": false,
"properties": {
"file": {
"$ref": "#/components/schemas/FileCreate"
},
"lease": {
"$ref": "#/components/schemas/LeaseProof"
},
"request_id": {
"format": "uuid",
"title": "Request Id",
"type": "string"
}
},
"required": [
"lease",
"request_id",
"file"
],
"title": "WorkerFileCreate",
"type": "object"
}WorkerFileRead
{
"additionalProperties": false,
"properties": {
"chunk": {
"$ref": "#/components/schemas/FileChunkRead"
},
"file_id": {
"format": "uuid",
"title": "File Id",
"type": "string"
},
"lease": {
"$ref": "#/components/schemas/LeaseProof"
}
},
"required": [
"lease",
"file_id",
"chunk"
],
"title": "WorkerFileRead",
"type": "object"
}WorkerImplementation
{
"additionalProperties": false,
"properties": {
"kind": {
"const": "worker",
"title": "Kind",
"type": "string"
},
"taskType": {
"$ref": "#/components/schemas/ResourceName"
},
"taskVersion": {
"$ref": "#/components/schemas/SemVer"
}
},
"required": [
"kind",
"taskType",
"taskVersion"
],
"title": "WorkerImplementation",
"type": "object"
}WorkerInstance
{
"additionalProperties": false,
"properties": {
"capacity": {
"maximum": 100,
"minimum": 1,
"title": "Capacity",
"type": "integer"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"principal_id": {
"format": "uuid",
"title": "Principal Id",
"type": "string"
},
"release_id": {
"format": "uuid",
"title": "Release Id",
"type": "string"
},
"revoked": {
"default": false,
"title": "Revoked",
"type": "boolean"
},
"task_types": {
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 1,
"title": "Task Types",
"type": "array"
}
},
"required": [
"release_id",
"task_types",
"capacity",
"id",
"principal_id"
],
"title": "WorkerInstance",
"type": "object"
}WorkerRelease
{
"additionalProperties": false,
"properties": {
"capabilities": {
"items": {
"$ref": "#/components/schemas/TaskCapability-Output"
},
"maxItems": 100,
"minItems": 1,
"title": "Capabilities",
"type": "array"
},
"connector_bindings": {
"items": {
"$ref": "#/components/schemas/ConnectorBinding"
},
"title": "Connector Bindings",
"type": "array"
},
"credential_capabilities": {
"items": {
"type": "string"
},
"maxItems": 100,
"title": "Credential Capabilities",
"type": "array"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"image_digest": {
"pattern": "^sha256:[a-f0-9]{64}$",
"title": "Image Digest",
"type": "string"
}
},
"required": [
"image_digest",
"capabilities",
"id"
],
"title": "WorkerRelease",
"type": "object"
}WorkerRouting
{
"additionalProperties": false,
"properties": {
"queue": {
"$ref": "#/components/schemas/ResourceName"
}
},
"required": [
"queue"
],
"title": "WorkerRouting",
"type": "object"
}WorkerStatus
{
"additionalProperties": false,
"description": "A scoped observation, separate from the stable worker registration protocol.",
"properties": {
"active_leases": {
"minimum": 0,
"title": "Active Leases",
"type": "integer"
},
"available_capacity": {
"anyOf": [
{
"maximum": 100,
"minimum": 0,
"type": "integer"
},
{
"type": "null"
}
],
"title": "Available Capacity"
},
"capacity": {
"maximum": 100,
"minimum": 1,
"title": "Capacity",
"type": "integer"
},
"draining": {
"title": "Draining",
"type": "boolean"
},
"id": {
"format": "uuid",
"title": "Id",
"type": "string"
},
"last_seen_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Last Seen At"
},
"observed_at": {
"format": "date-time",
"title": "Observed At",
"type": "string"
},
"presence": {
"enum": [
"unknown",
"recent",
"stale"
],
"title": "Presence",
"type": "string"
},
"presence_expires_at": {
"anyOf": [
{
"format": "date-time",
"type": "string"
},
{
"type": "null"
}
],
"title": "Presence Expires At"
},
"presence_ttl_seconds": {
"const": 60,
"default": 60,
"title": "Presence Ttl Seconds",
"type": "integer"
},
"principal_id": {
"format": "uuid",
"title": "Principal Id",
"type": "string"
},
"release_id": {
"format": "uuid",
"title": "Release Id",
"type": "string"
},
"revision": {
"minimum": 1,
"title": "Revision",
"type": "integer"
},
"revoked": {
"default": false,
"title": "Revoked",
"type": "boolean"
},
"task_types": {
"items": {
"type": "string"
},
"maxItems": 100,
"minItems": 1,
"title": "Task Types",
"type": "array"
}
},
"required": [
"release_id",
"task_types",
"capacity",
"id",
"principal_id",
"revision",
"draining",
"presence",
"last_seen_at",
"presence_expires_at",
"observed_at",
"active_leases",
"available_capacity"
],
"title": "WorkerStatus",
"type": "object"
}WorkflowDefinition-Input
{
"additionalProperties": false,
"properties": {
"apiVersion": {
"const": "weave/v1alpha1",
"title": "Apiversion",
"type": "string"
},
"kind": {
"const": "Workflow",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"spec": {
"$ref": "#/components/schemas/WorkflowSpec-Input"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "WorkflowDefinition",
"type": "object"
}WorkflowDefinition-Output
{
"additionalProperties": false,
"properties": {
"apiVersion": {
"const": "weave/v1alpha1",
"title": "Apiversion",
"type": "string"
},
"kind": {
"const": "Workflow",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"spec": {
"$ref": "#/components/schemas/WorkflowSpec-Output"
}
},
"required": [
"apiVersion",
"kind",
"metadata",
"spec"
],
"title": "WorkflowDefinition",
"type": "object"
}WorkflowIR
{
"additionalProperties": false,
"properties": {
"apiVersion": {
"const": "weave/v1alpha1",
"title": "Apiversion",
"type": "string"
},
"connections": {
"additionalProperties": {
"$ref": "#/components/schemas/ConnectionRequirement"
},
"propertyNames": {
"$ref": "#/components/schemas/ResourceName"
},
"title": "Connections",
"type": "object"
},
"dependencies": {
"items": {
"$ref": "#/components/schemas/Dependency"
},
"title": "Dependencies",
"type": "array"
},
"features": {
"items": {
"$ref": "#/components/schemas/LanguageFeature"
},
"title": "Features",
"type": "array",
"uniqueItems": true
},
"graph": {
"$ref": "#/components/schemas/IRGraph"
},
"guards": {
"items": {
"$ref": "#/components/schemas/Guard"
},
"title": "Guards",
"type": "array"
},
"inputSchema": {
"$ref": "#/components/schemas/firefly_weave__compiler__ir__Digest"
},
"irVersion": {
"enum": [
"weave/ir-v1alpha1",
"weave/ir-v1alpha2",
"weave/ir-v1alpha3"
],
"title": "Irversion",
"type": "string"
},
"kind": {
"const": "Workflow",
"title": "Kind",
"type": "string"
},
"metadata": {
"$ref": "#/components/schemas/Metadata"
},
"outputSchema": {
"$ref": "#/components/schemas/firefly_weave__compiler__ir__Digest"
},
"schemas": {
"additionalProperties": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"propertyNames": {
"$ref": "#/components/schemas/firefly_weave__compiler__ir__Digest"
},
"title": "Schemas",
"type": "object"
},
"timeoutSeconds": {
"anyOf": [
{
"$ref": "#/components/schemas/PositiveInt"
},
{
"type": "null"
}
]
}
},
"required": [
"irVersion",
"apiVersion",
"metadata",
"dependencies",
"schemas",
"guards",
"kind",
"inputSchema",
"outputSchema",
"connections",
"timeoutSeconds",
"graph"
],
"title": "WorkflowIR",
"type": "object"
}WorkflowSpec-Input
{
"additionalProperties": false,
"properties": {
"callable": {
"$ref": "#/components/schemas/OmissionOnly_CallableSpec_"
},
"connections": {
"additionalProperties": {
"$ref": "#/components/schemas/ConnectionRequirement"
},
"propertyNames": {
"$ref": "#/components/schemas/ResourceName"
},
"title": "Connections",
"type": "object"
},
"inputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"llmProfiles": {
"$ref": "#/components/schemas/OmissionOnly_dict_ResourceName__LLMProfile___MaxLen_max_length_32_-Input",
"maxLength": 32
},
"output": {
"$ref": "#/components/schemas/Expression-Input"
},
"outputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Input"
},
"steps": {
"items": {
"$ref": "#/components/schemas/Step-Input"
},
"title": "Steps",
"type": "array"
},
"timeoutSeconds": {
"$ref": "#/components/schemas/OmissionOnly_PositiveInt_"
}
},
"required": [
"inputSchema",
"outputSchema",
"steps",
"output"
],
"title": "WorkflowSpec",
"type": "object"
}WorkflowSpec-Output
{
"additionalProperties": false,
"properties": {
"callable": {
"$ref": "#/components/schemas/OmissionOnly_CallableSpec_"
},
"connections": {
"additionalProperties": {
"$ref": "#/components/schemas/ConnectionRequirement"
},
"propertyNames": {
"$ref": "#/components/schemas/ResourceName"
},
"title": "Connections",
"type": "object"
},
"inputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"llmProfiles": {
"$ref": "#/components/schemas/OmissionOnly_dict_ResourceName__LLMProfile___MaxLen_max_length_32_-Output",
"maxLength": 32
},
"output": {
"$ref": "#/components/schemas/Expression-Output"
},
"outputSchema": {
"$ref": "#/components/schemas/JsonObjectData-Output"
},
"steps": {
"items": {
"$ref": "#/components/schemas/Step-Output"
},
"title": "Steps",
"type": "array"
},
"timeoutSeconds": {
"$ref": "#/components/schemas/OmissionOnly_PositiveInt_"
}
},
"required": [
"inputSchema",
"outputSchema",
"steps",
"output"
],
"title": "WorkflowSpec",
"type": "object"
}firefly_weave__compiler__ir__Digest
{
"allOf": [
{
"$ref": "#/components/schemas/UnicodeString_a-f0-9__64____"
},
{
"pattern": "^[a-f0-9]{64}$",
"type": "string"
}
]
}firefly_weave__compiler__ir__SwitchCase
{
"additionalProperties": false,
"properties": {
"branch": {
"$ref": "#/components/schemas/UnicodeString"
},
"target": {
"$ref": "#/components/schemas/NodeId"
},
"when": {
"$ref": "#/components/schemas/Expression-Output"
}
},
"required": [
"branch",
"when",
"target"
],
"title": "SwitchCase",
"type": "object"
}firefly_weave__contracts__catalog__Digest
{
"pattern": "^[0-9a-f]{64}$",
"type": "string"
}firefly_weave__contracts__definitions__SwitchCase-Output
{
"additionalProperties": false,
"properties": {
"output": {
"$ref": "#/components/schemas/Expression-Output"
},
"steps": {
"items": {
"$ref": "#/components/schemas/Step-Output"
},
"title": "Steps",
"type": "array"
},
"when": {
"$ref": "#/components/schemas/Expression-Output"
}
},
"required": [
"steps",
"output",
"when"
],
"title": "SwitchCase",
"type": "object"
}firefly_weave__contracts__providers__Digest
{
"pattern": "^[a-f0-9]{64}$",
"type": "string"
}