{ "openapi": "3.1.0", "info": { "title": "Archal API", "version": "1.0.0", "summary": "Stateful testing environments with separate lifecycle and provider-scoped credentials", "description": "Use a workspace credential for lifecycle operations. Each created environment returns a short-lived provider-shaped credential for its isolated data plane; the workspace credential is never forwarded to or accepted by provider-compatible endpoints." }, "servers": [ { "url": "https://api.archal.ai" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "Archal workspace API key", "description": "Used by lifecycle, catalog, and state endpoints" }, "providerScopedCredential": { "type": "apiKey", "in": "header", "name": "Authorization", "description": "Representative OpenAPI security field. The exact provider-shaped header names and values are returned in environments.*.credentials.headers and are authoritative." } } }, "paths": { "/api/environments": { "get": { "operationId": "listEnvironments", "summary": "List environment capabilities and state contracts", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "schema": { "type": "string", "const": "archal.environment-catalog" }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "environments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 80 }, "name": { "type": "string", "minLength": 1 }, "availability": { "type": "string", "enum": [ "available", "in-progress" ] }, "startable": { "type": "boolean" }, "launch": { "type": "boolean" }, "transports": { "type": "array", "items": { "type": "string", "enum": [ "rest", "mcp" ] } }, "certification": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "healthy", "degraded", "quarantined", "unknown" ] }, "admission": { "type": "string", "enum": [ "allow", "warn", "deny" ] }, "checkedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "evidenceSha256": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{64}$" }, { "type": "null" } ] } }, "required": [ "status", "admission", "checkedAt", "evidenceSha256" ], "additionalProperties": false }, "state": { "type": "object", "properties": { "readable": { "type": "boolean" }, "writable": { "type": "boolean" }, "resettable": { "type": "boolean" }, "formats": { "type": "array", "items": { "type": "string", "enum": [ "json", "sql" ] } }, "contract": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] } }, "required": [ "readable", "writable", "resettable", "formats", "contract" ], "additionalProperties": false } }, "required": [ "id", "name", "availability", "startable", "launch", "transports", "certification", "state" ], "additionalProperties": false } } }, "required": [ "schema", "version", "environments" ], "additionalProperties": false } } } }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } } }, "/api/environments/{environmentId}": { "get": { "operationId": "describeEnvironment", "summary": "Describe one environment and its certification", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 80 }, "name": { "type": "string", "minLength": 1 }, "availability": { "type": "string", "enum": [ "available", "in-progress" ] }, "startable": { "type": "boolean" }, "launch": { "type": "boolean" }, "transports": { "type": "array", "items": { "type": "string", "enum": [ "rest", "mcp" ] } }, "certification": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "healthy", "degraded", "quarantined", "unknown" ] }, "admission": { "type": "string", "enum": [ "allow", "warn", "deny" ] }, "checkedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "evidenceSha256": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{64}$" }, { "type": "null" } ] } }, "required": [ "status", "admission", "checkedAt", "evidenceSha256" ], "additionalProperties": false }, "state": { "type": "object", "properties": { "readable": { "type": "boolean" }, "writable": { "type": "boolean" }, "resettable": { "type": "boolean" }, "formats": { "type": "array", "items": { "type": "string", "enum": [ "json", "sql" ] } }, "contract": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, { "type": "null" } ] } }, "required": [ "readable", "writable", "resettable", "formats", "contract" ], "additionalProperties": false } }, "required": [ "id", "name", "availability", "startable", "launch", "transports", "certification", "state" ], "additionalProperties": false } } } }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } } }, "/api/environments/{environmentId}/state/validate": { "post": { "operationId": "validateEnvironmentState", "summary": "Validate state without starting an environment", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } }, "text/sql": { "schema": { "type": "string", "minLength": 1 } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "schema": { "type": "string", "const": "archal.environment-state-validation" }, "version": { "type": "number", "const": 1 }, "environmentId": { "type": "string", "minLength": 1, "maxLength": 80 }, "format": { "type": "string", "enum": [ "json", "sql" ] }, "valid": { "type": "boolean" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 } }, "required": [ "path", "message" ], "additionalProperties": {} } }, "contract": { "anyOf": [ { "type": "object", "properties": { "schema": { "type": "string", "minLength": 1 }, "version": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "schema", "version" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "schema", "version", "environmentId", "format", "valid", "issues", "contract" ], "additionalProperties": false } } } }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "415": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } } }, "/api/sessions": { "get": { "operationId": "listEnvironmentSessions", "summary": "List environment sessions", "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "sessions": { "type": "array", "items": { "type": "object", "properties": { "sessionId": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "starting", "ready", "running", "tearing_down", "ended", "expired", "failed" ] }, "environmentIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80 } }, "environments": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "status": { "type": "string", "const": "ready" }, "apiBaseUrl": { "type": "string", "format": "uri" }, "mcpUrl": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] }, "credentials": { "type": "object", "properties": { "kind": { "type": "string", "const": "provider" }, "expiresAt": { "type": "string", "minLength": 1 }, "headers": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "minLength": 1 } } }, "required": [ "kind", "expiresAt", "headers" ], "additionalProperties": false } }, "required": [ "status", "apiBaseUrl", "mcpUrl", "credentials" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "starting", "dead" ] }, "apiBaseUrl": { "type": "null" }, "mcpUrl": { "type": "null" }, "credentials": { "type": "null" } }, "required": [ "status", "apiBaseUrl", "mcpUrl", "credentials" ], "additionalProperties": false } ] } }, "createdAt": { "type": "string", "minLength": 1 }, "expiresAt": { "type": "string", "minLength": 1 }, "endedAt": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "teardownRequestedAt": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "lease": { "type": "object", "properties": { "expiresAt": { "type": "string", "minLength": 1 }, "idleExpiresAt": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hardExpiresAt": { "type": "string", "minLength": 1 }, "renewable": { "type": "boolean" } }, "required": [ "expiresAt", "idleExpiresAt", "hardExpiresAt", "renewable" ], "additionalProperties": false } }, "required": [ "sessionId", "status", "environmentIds", "environments", "createdAt", "expiresAt", "endedAt" ], "additionalProperties": false } } }, "required": [ "sessions" ], "additionalProperties": false } } } }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } }, "post": { "operationId": "createEnvironmentSession", "summary": "Create environments with optional initial state", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ttlSeconds": { "type": "integer", "minimum": 1, "maximum": 14400 }, "initialState": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "format": { "type": "string", "const": "json" }, "value": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "format", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "format": { "type": "string", "const": "sql" }, "value": { "type": "string", "minLength": 1 } }, "required": [ "format", "value" ], "additionalProperties": false } ] } }, "environments": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80 } } }, "required": [ "environments" ], "additionalProperties": false } } } }, "responses": { "201": { "description": "Environment session created", "content": { "application/json": { "schema": { "type": "object", "properties": { "sessionId": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "starting", "ready", "running", "tearing_down", "ended", "expired", "failed" ] }, "environmentIds": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80 } }, "environments": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "status": { "type": "string", "const": "ready" }, "apiBaseUrl": { "type": "string", "format": "uri" }, "mcpUrl": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] }, "credentials": { "type": "object", "properties": { "kind": { "type": "string", "const": "provider" }, "expiresAt": { "type": "string", "minLength": 1 }, "headers": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "minLength": 1 } } }, "required": [ "kind", "expiresAt", "headers" ], "additionalProperties": false } }, "required": [ "status", "apiBaseUrl", "mcpUrl", "credentials" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "starting", "dead" ] }, "apiBaseUrl": { "type": "null" }, "mcpUrl": { "type": "null" }, "credentials": { "type": "null" } }, "required": [ "status", "apiBaseUrl", "mcpUrl", "credentials" ], "additionalProperties": false } ] } }, "expiresAt": { "type": "string", "minLength": 1 }, "certificationWarnings": { "type": "array", "items": { "type": "object", "properties": { "environmentId": { "type": "string", "minLength": 1, "maxLength": 80 }, "code": { "type": "string", "const": "ENVIRONMENT_CERTIFICATION_DEGRADED" }, "message": { "type": "string", "minLength": 1 }, "certification": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "healthy", "degraded", "quarantined", "unknown" ] }, "admission": { "type": "string", "enum": [ "allow", "warn", "deny" ] }, "checkedAt": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, { "type": "null" } ] }, "evidenceSha256": { "anyOf": [ { "type": "string", "pattern": "^[a-f0-9]{64}$" }, { "type": "null" } ] } }, "required": [ "status", "admission", "checkedAt", "evidenceSha256" ], "additionalProperties": false } }, "required": [ "environmentId", "code", "message", "certification" ], "additionalProperties": false } }, "lease": { "type": "object", "properties": { "expiresAt": { "type": "string", "minLength": 1 }, "idleExpiresAt": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hardExpiresAt": { "type": "string", "minLength": 1 }, "renewable": { "type": "boolean" } }, "required": [ "expiresAt", "idleExpiresAt", "hardExpiresAt", "renewable" ], "additionalProperties": false }, "workspace": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1 }, "name": { "type": "string", "minLength": 1 } }, "required": [ "id" ], "additionalProperties": false } }, "required": [ "sessionId", "status", "environmentIds", "environments", "expiresAt" ], "additionalProperties": false } } } }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "402": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } } }, "/api/sessions/{sessionId}": { "get": { "operationId": "getEnvironmentSession", "summary": "Inspect readiness and environment connection URLs", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "sessionId": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "starting", "ready", "running", "tearing_down", "ended", "expired", "failed" ] }, "alive": { "type": "boolean" }, "environmentIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80 } }, "environments": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "status": { "type": "string", "const": "ready" }, "apiBaseUrl": { "type": "string", "format": "uri" }, "mcpUrl": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] }, "credentials": { "type": "object", "properties": { "kind": { "type": "string", "const": "provider" }, "expiresAt": { "type": "string", "minLength": 1 }, "headers": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "minLength": 1 } } }, "required": [ "kind", "expiresAt", "headers" ], "additionalProperties": false } }, "required": [ "status", "apiBaseUrl", "mcpUrl", "credentials" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "starting", "dead" ] }, "apiBaseUrl": { "type": "null" }, "mcpUrl": { "type": "null" }, "credentials": { "type": "null" } }, "required": [ "status", "apiBaseUrl", "mcpUrl", "credentials" ], "additionalProperties": false } ] } }, "createdAt": { "type": "string", "minLength": 1 }, "expiresAt": { "type": "string", "minLength": 1 }, "endedAt": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "teardownRequestedAt": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "lease": { "type": "object", "properties": { "expiresAt": { "type": "string", "minLength": 1 }, "idleExpiresAt": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hardExpiresAt": { "type": "string", "minLength": 1 }, "renewable": { "type": "boolean" } }, "required": [ "expiresAt", "idleExpiresAt", "hardExpiresAt", "renewable" ], "additionalProperties": false } }, "required": [ "sessionId", "status", "alive", "environmentIds", "environments", "createdAt", "expiresAt", "endedAt" ], "additionalProperties": false } } } }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } }, "delete": { "operationId": "destroyEnvironmentSession", "summary": "Destroy a session and release its runtime resources", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "Prefer", "in": "header", "required": false, "schema": { "type": "string", "enum": [ "respond-async" ] }, "description": "Use respond-async to return after durable teardown intent is persisted." } ], "responses": { "202": { "description": "Durable teardown accepted; physical cleanup continues", "content": { "application/json": { "schema": { "type": "object", "properties": { "sessionId": { "type": "string", "minLength": 1 }, "status": { "type": "string", "const": "tearing_down" }, "teardownRequestedAt": { "type": "string", "minLength": 1 } }, "required": [ "sessionId", "status", "teardownRequestedAt" ], "additionalProperties": false } } } }, "204": { "description": "Environment session destroyed" }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } } }, "/api/sessions/{sessionId}/renew": { "post": { "operationId": "renewEnvironmentSession", "summary": "Extend an active environment session", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "ttlSeconds": { "type": "integer", "minimum": 1, "maximum": 14400 } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "sessionId": { "type": "string", "minLength": 1 }, "status": { "type": "string", "enum": [ "starting", "ready", "running", "tearing_down", "ended", "expired", "failed" ] }, "expiresAt": { "type": "string", "minLength": 1 }, "lease": { "type": "object", "properties": { "expiresAt": { "type": "string", "minLength": 1 }, "idleExpiresAt": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "hardExpiresAt": { "type": "string", "minLength": 1 }, "renewable": { "type": "boolean" } }, "required": [ "expiresAt", "idleExpiresAt", "hardExpiresAt", "renewable" ], "additionalProperties": false }, "environmentIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80 } }, "environments": { "type": "object", "propertyNames": { "type": "string", "minLength": 1, "maxLength": 80 }, "additionalProperties": { "oneOf": [ { "type": "object", "properties": { "status": { "type": "string", "const": "ready" }, "apiBaseUrl": { "type": "string", "format": "uri" }, "mcpUrl": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] }, "credentials": { "type": "object", "properties": { "kind": { "type": "string", "const": "provider" }, "expiresAt": { "type": "string", "minLength": 1 }, "headers": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "string", "minLength": 1 } } }, "required": [ "kind", "expiresAt", "headers" ], "additionalProperties": false } }, "required": [ "status", "apiBaseUrl", "mcpUrl", "credentials" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "type": "string", "enum": [ "starting", "dead" ] }, "apiBaseUrl": { "type": "null" }, "mcpUrl": { "type": "null" }, "credentials": { "type": "null" } }, "required": [ "status", "apiBaseUrl", "mcpUrl", "credentials" ], "additionalProperties": false } ] } } }, "required": [ "sessionId", "status", "expiresAt", "environmentIds", "environments" ], "additionalProperties": false } } } }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } } }, "/api/sessions/{sessionId}/reset": { "post": { "operationId": "resetAllSessionEnvironments", "summary": "Reset every stateful environment in a session", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } } }, "/api/sessions/{sessionId}/environments/{environmentId}/state": { "get": { "operationId": "getEnvironmentState", "summary": "Inspect environment state", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "schema": { "type": "string", "const": "archal.environment-state" }, "version": { "type": "number", "const": 1 }, "sessionId": { "type": "string", "minLength": 1 }, "environmentId": { "type": "string", "minLength": 1, "maxLength": 80 }, "state": {} }, "required": [ "schema", "version", "sessionId", "environmentId", "state" ], "additionalProperties": false } } } }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } }, "put": { "operationId": "replaceEnvironmentState", "summary": "Replace environment state and its reset baseline", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } }, "text/sql": { "schema": { "type": "string", "minLength": 1 } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "sessionId": { "type": "string" }, "environmentId": { "type": "string" }, "format": { "enum": [ "json", "sql" ] }, "baselineUpdated": { "const": true } }, "required": [ "ok", "sessionId", "environmentId", "format", "baselineUpdated" ], "additionalProperties": false } } } }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "415": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } } }, "/api/sessions/{sessionId}/environments/{environmentId}/reset": { "post": { "operationId": "resetEnvironment", "summary": "Reset one environment to its baseline", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "sessionId": { "type": "string" }, "environmentId": { "type": "string" } }, "required": [ "ok", "sessionId", "environmentId" ], "additionalProperties": false } } } }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } } }, "/api/sessions/{sessionId}/environments/{environmentId}/state/diff": { "post": { "operationId": "diffEnvironmentState", "summary": "Compare explicit prior state with current state", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "source": { "type": "string", "const": "explicit" }, "before": {}, "maxChanges": { "type": "integer", "minimum": 1, "maximum": 1000 } }, "required": [ "source", "before" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "schema": { "type": "string", "const": "archal.environment-state-diff" }, "version": { "type": "number", "const": 1 }, "sessionId": { "type": "string", "minLength": 1 }, "environmentId": { "type": "string", "minLength": 1, "maxLength": 80 }, "beforeSha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "afterSha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "changed": { "type": "boolean" }, "totalChanges": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "returnedChanges": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "truncated": { "type": "boolean" }, "changes": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "add", "remove", "replace" ] }, "path": { "type": "string" }, "before": {}, "after": {} }, "required": [ "op", "path" ], "additionalProperties": false } } }, "required": [ "schema", "version", "sessionId", "environmentId", "beforeSha256", "afterSha256", "changed", "totalChanges", "returnedChanges", "truncated", "changes" ], "additionalProperties": false } } } }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } } }, "/api/sessions/{sessionId}/evidence": { "get": { "operationId": "getEnvironmentSessionEvidence", "summary": "Get bounded request metadata and retention status", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } } ], "responses": { "200": { "description": "Successful response", "content": { "application/json": { "schema": { "type": "object", "properties": { "schema": { "type": "string", "const": "archal.session-evidence-summary" }, "version": { "type": "number", "const": 1 }, "sessionId": { "type": "string", "minLength": 1 }, "status": { "type": "string", "minLength": 1 }, "finalizedAt": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "capture": { "type": "object", "properties": { "mode": { "type": "string", "const": "metadata" }, "environmentIds": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 80 } }, "requestCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "artifactCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "rawExportAvailable": { "type": "boolean", "const": false } }, "required": [ "mode", "environmentIds", "requestCount", "artifactCount", "rawExportAvailable" ], "additionalProperties": false }, "retention": { "type": "object", "properties": { "rawExpiresAt": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] }, "metadataExpiresAt": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "rawExpiresAt", "metadataExpiresAt" ], "additionalProperties": false }, "integrity": { "type": "object", "properties": { "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" } }, "required": [ "sha256" ], "additionalProperties": false } }, "required": [ "schema", "version", "sessionId", "status", "finalizedAt", "capture", "retention", "integrity" ], "additionalProperties": false } } } }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } } }, "/v1/sessions/{sessionId}/environments/{environmentId}/api/{providerPath}": { "get": { "operationId": "callEnvironmentGet", "summary": "Send a GET request to an environment", "description": "Authenticate only with the provider-shaped headers returned in environments.*.credentials.headers. Archal validates that scoped credential for this session and environment, replaces it with a private worker credential, and preserves the provider path, query, body, status, and safe response headers. Workspace control-plane credentials are rejected.", "security": [ { "providerScopedCredential": [] } ], "x-archal-dynamic-credential-headers": true, "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } }, { "name": "providerPath", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Provider-shaped path below the environment API root" }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,128}$" } } ], "responses": { "200": { "description": "Provider-compatible response", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": true } ] } }, "text/plain": { "schema": { "type": "string" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "204": { "description": "Provider-compatible empty response" }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "408": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "415": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "504": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } }, "post": { "operationId": "callEnvironmentPost", "summary": "Send a POST request to an environment", "description": "Authenticate only with the provider-shaped headers returned in environments.*.credentials.headers. Archal validates that scoped credential for this session and environment, replaces it with a private worker credential, and preserves the provider path, query, body, status, and safe response headers. Workspace control-plane credentials are rejected.", "security": [ { "providerScopedCredential": [] } ], "x-archal-dynamic-credential-headers": true, "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } }, { "name": "providerPath", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Provider-shaped path below the environment API root" }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,128}$" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": true } ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } }, "text/plain": { "schema": { "type": "string" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "200": { "description": "Provider-compatible response", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": true } ] } }, "text/plain": { "schema": { "type": "string" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "204": { "description": "Provider-compatible empty response" }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "408": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "415": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "504": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } }, "put": { "operationId": "callEnvironmentPut", "summary": "Send a PUT request to an environment", "description": "Authenticate only with the provider-shaped headers returned in environments.*.credentials.headers. Archal validates that scoped credential for this session and environment, replaces it with a private worker credential, and preserves the provider path, query, body, status, and safe response headers. Workspace control-plane credentials are rejected.", "security": [ { "providerScopedCredential": [] } ], "x-archal-dynamic-credential-headers": true, "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } }, { "name": "providerPath", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Provider-shaped path below the environment API root" }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,128}$" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": true } ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } }, "text/plain": { "schema": { "type": "string" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "200": { "description": "Provider-compatible response", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": true } ] } }, "text/plain": { "schema": { "type": "string" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "204": { "description": "Provider-compatible empty response" }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "408": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "415": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "504": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } }, "patch": { "operationId": "callEnvironmentPatch", "summary": "Send a PATCH request to an environment", "description": "Authenticate only with the provider-shaped headers returned in environments.*.credentials.headers. Archal validates that scoped credential for this session and environment, replaces it with a private worker credential, and preserves the provider path, query, body, status, and safe response headers. Workspace control-plane credentials are rejected.", "security": [ { "providerScopedCredential": [] } ], "x-archal-dynamic-credential-headers": true, "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } }, { "name": "providerPath", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Provider-shaped path below the environment API root" }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,128}$" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": true } ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } }, "text/plain": { "schema": { "type": "string" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "200": { "description": "Provider-compatible response", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": true } ] } }, "text/plain": { "schema": { "type": "string" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "204": { "description": "Provider-compatible empty response" }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "408": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "415": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "504": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } }, "delete": { "operationId": "callEnvironmentDelete", "summary": "Send a DELETE request to an environment", "description": "Authenticate only with the provider-shaped headers returned in environments.*.credentials.headers. Archal validates that scoped credential for this session and environment, replaces it with a private worker credential, and preserves the provider path, query, body, status, and safe response headers. Workspace control-plane credentials are rejected.", "security": [ { "providerScopedCredential": [] } ], "x-archal-dynamic-credential-headers": true, "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } }, { "name": "providerPath", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Provider-shaped path below the environment API root" }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,128}$" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": true } ] } }, "application/x-www-form-urlencoded": { "schema": { "type": "object", "additionalProperties": true } }, "text/plain": { "schema": { "type": "string" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "responses": { "200": { "description": "Provider-compatible response", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": true } ] } }, "text/plain": { "schema": { "type": "string" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "204": { "description": "Provider-compatible empty response" }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "408": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "415": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "504": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } }, "head": { "operationId": "callEnvironmentHead", "summary": "Send a HEAD request to an environment", "description": "Authenticate only with the provider-shaped headers returned in environments.*.credentials.headers. Archal validates that scoped credential for this session and environment, replaces it with a private worker credential, and preserves the provider path, query, body, status, and safe response headers. Workspace control-plane credentials are rejected.", "security": [ { "providerScopedCredential": [] } ], "x-archal-dynamic-credential-headers": true, "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } }, { "name": "providerPath", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Provider-shaped path below the environment API root" }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,128}$" } } ], "responses": { "200": { "description": "Provider-compatible response", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": true } ] } }, "text/plain": { "schema": { "type": "string" } }, "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "204": { "description": "Provider-compatible empty response" }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "408": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "413": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "415": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "504": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } } }, "/v1/sessions/{sessionId}/environments/{environmentId}/mcp": { "post": { "operationId": "callEnvironmentMcp", "summary": "Send a Streamable HTTP MCP request to an environment", "description": "Use only the provider-shaped, session-scoped credential returned beside mcpUrl. Archal validates its session, environment, and lease binding before proxying the MCP request. Workspace control-plane credentials are rejected.", "security": [ { "providerScopedCredential": [] } ], "x-archal-dynamic-credential-headers": true, "parameters": [ { "name": "sessionId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1 } }, { "name": "environmentId", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 80 } }, { "name": "Mcp-Session-Id", "in": "header", "required": false, "schema": { "type": "string" } }, { "name": "X-Request-Id", "in": "header", "required": false, "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{1,128}$" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": true } ] } } } }, "responses": { "200": { "description": "Streamable HTTP MCP response", "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": true } ] } } } }, "202": { "description": "MCP notification accepted", "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "type": "boolean" }, { "type": "number" }, { "type": "string" }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": true } ] } } } }, "400": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "401": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "403": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "404": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "409": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "429": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "500": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "502": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "503": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } }, "504": { "description": "The request was rejected", "headers": { "X-Request-Id": { "description": "Request correlation identifier", "schema": { "type": "string" } }, "Retry-After": { "description": "Seconds to wait before retrying when present", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" }, "error": { "type": "string" }, "code": { "type": "string" }, "message": { "type": "string" }, "requestId": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "path", "message" ], "additionalProperties": true } } }, "additionalProperties": true } } } } } } } } }