{ "components": { "schemas": { "Error": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" }, "MutationResult": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" }, "Resource": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" } }, "securitySchemes": { "bearerAuth": { "scheme": "bearer", "type": "http" }, "sessionAuth": { "in": "cookie", "name": "hf_session", "type": "apiKey" } } }, "info": { "description": "Exact project ownership and original-byte webhook delivery. Cookie mutations require the exact Origin and X-CSRF-Token. Re-evaluation application requires Idempotency-Key and a matching preview_token. expected_revision refers to the record version, not its immutable URL/route revision.", "title": "HookFork API", "version": "0.1.0" }, "openapi": "3.0.3", "paths": { "/api/v1/audit": { "get": { "operationId": "get_api_v1_audit", "parameters": [ { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "project_id", "schema": { "type": "string" } }, { "in": "query", "name": "source_id", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "after", "schema": { "type": "string" } }, { "in": "query", "name": "before", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 25, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": "string" } }, "required": [ "data", "next_cursor" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/audit/{id}": { "get": { "operationId": "get_api_v1_audit_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/billing": { "get": { "operationId": "get_api_v1_billing", "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "exempt": { "type": "boolean" }, "payments_enabled": { "type": "boolean" }, "service_access": { "type": "boolean" }, "state": { "type": "string" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/billing/checkout": { "post": { "operationId": "post_api_v1_billing_checkout", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "url": { "type": "string" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/billing/portal": { "post": { "operationId": "post_api_v1_billing_portal", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "url": { "type": "string" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/billing/reconcile": { "post": { "operationId": "post_api_v1_billing_reconcile", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "url": { "type": "string" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/deliveries": { "get": { "operationId": "get_api_v1_deliveries", "parameters": [ { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "project_id", "schema": { "type": "string" } }, { "in": "query", "name": "source_id", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "after", "schema": { "type": "string" } }, { "in": "query", "name": "before", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 25, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": "string" } }, "required": [ "data", "next_cursor" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/deliveries/{id}": { "get": { "operationId": "get_api_v1_deliveries_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/deliveries/{id}/replay": { "post": { "operationId": "post_api_v1_deliveries_id_replay", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "reason": { "maxLength": 1024, "type": "string" } }, "required": [ "reason" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/destinations": { "get": { "operationId": "get_api_v1_destinations", "parameters": [ { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "project_id", "schema": { "type": "string" } }, { "in": "query", "name": "source_id", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "after", "schema": { "type": "string" } }, { "in": "query", "name": "before", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 25, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": "string" } }, "required": [ "data", "next_cursor" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] }, "post": { "operationId": "post_api_v1_destinations", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "name": { "maxLength": 1024, "type": "string" }, "project_id": { "maxLength": 1024, "type": "string" }, "url": { "format": "uri", "maxLength": 2048, "type": "string" } }, "required": [ "name", "project_id", "url" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/destinations/{id}": { "get": { "operationId": "get_api_v1_destinations_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/destinations/{id}/pause": { "post": { "operationId": "post_api_v1_destinations_id_pause", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" } }, "required": [ "expected_revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/destinations/{id}/probe": { "post": { "operationId": "post_api_v1_destinations_id_probe", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" } }, "required": [ "expected_revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/destinations/{id}/resume": { "post": { "operationId": "post_api_v1_destinations_id_resume", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" } }, "required": [ "expected_revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/destinations/{id}/revisions": { "post": { "operationId": "post_api_v1_destinations_id_revisions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" }, "url": { "format": "uri", "maxLength": 2048, "type": "string" } }, "required": [ "expected_revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/destinations/{id}/secrets/rotate": { "post": { "operationId": "post_api_v1_destinations_id_secrets_rotate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "overlap_seconds": { "maximum": 86400, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" } }, "required": [ "expected_revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/events": { "get": { "operationId": "get_api_v1_events", "parameters": [ { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "project_id", "schema": { "type": "string" } }, { "in": "query", "name": "source_id", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "after", "schema": { "type": "string" } }, { "in": "query", "name": "before", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 25, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": "string" } }, "required": [ "data", "next_cursor" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/events/{id}": { "get": { "operationId": "get_api_v1_events_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/events/{id}/payload": { "get": { "operationId": "get_api_v1_events_id_payload", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "required": [ "id", "type", "data" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/events/{id}/reevaluate": { "post": { "operationId": "post_api_v1_events_id_reevaluate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "apply": { "type": "boolean" }, "preview_token": { "maxLength": 1024, "type": "string" }, "reason": { "maxLength": 1024, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/me": { "get": { "operationId": "get_api_v1_me", "responses": { "200": { "content": { "application/json": { "schema": { "required": [ "tenant_id", "actor_id", "owner", "projects", "scopes" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/projects": { "get": { "operationId": "get_api_v1_projects", "parameters": [ { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "project_id", "schema": { "type": "string" } }, { "in": "query", "name": "source_id", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "after", "schema": { "type": "string" } }, { "in": "query", "name": "before", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 25, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": "string" } }, "required": [ "data", "next_cursor" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] }, "post": { "operationId": "post_api_v1_projects", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "name": { "maxLength": 1024, "type": "string" } }, "required": [ "name" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/projects/{id}": { "get": { "operationId": "get_api_v1_projects_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/projects/{id}/pause": { "post": { "operationId": "post_api_v1_projects_id_pause", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" } }, "required": [ "expected_revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/projects/{id}/resume": { "post": { "operationId": "post_api_v1_projects_id_resume", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" } }, "required": [ "expected_revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/resource-claims": { "get": { "operationId": "get_api_v1_resource_claims", "parameters": [ { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "project_id", "schema": { "type": "string" } }, { "in": "query", "name": "source_id", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "after", "schema": { "type": "string" } }, { "in": "query", "name": "before", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 25, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": "string" } }, "required": [ "data", "next_cursor" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] }, "post": { "operationId": "post_api_v1_resource_claims", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "project_id": { "maxLength": 1024, "type": "string" }, "resource_id": { "maxLength": 1024, "type": "string" }, "resource_type": { "enum": [ "price", "product", "payment_link" ], "type": "string" }, "source_id": { "maxLength": 1024, "type": "string" } }, "required": [ "source_id", "project_id", "resource_type", "resource_id" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/resource-claims/{id}": { "get": { "operationId": "get_api_v1_resource_claims_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/resource-claims/{id}/revoke": { "post": { "operationId": "post_api_v1_resource_claims_id_revoke", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/routes": { "get": { "operationId": "get_api_v1_routes", "parameters": [ { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "project_id", "schema": { "type": "string" } }, { "in": "query", "name": "source_id", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "after", "schema": { "type": "string" } }, { "in": "query", "name": "before", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 25, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": "string" } }, "required": [ "data", "next_cursor" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] }, "post": { "operationId": "post_api_v1_routes", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "destination_revision_ids": { "items": { "minLength": 1, "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array", "uniqueItems": true }, "event_types": { "items": { "enum": [ "checkout.session.completed", "checkout.session.async_payment_succeeded", "checkout.session.async_payment_failed", "checkout.session.expired", "customer.subscription.created", "customer.subscription.updated", "customer.subscription.deleted", "customer.subscription.trial_will_end", "customer.subscription.paused", "customer.subscription.resumed", "invoice.created", "invoice.finalized", "invoice.finalization_failed", "invoice.updated", "invoice.paid", "invoice.payment_failed", "invoice.payment_action_required", "invoice.voided", "invoice.marked_uncollectible" ], "type": "string" }, "maxItems": 19, "minItems": 1, "type": "array", "uniqueItems": true }, "name": { "maxLength": 1024, "type": "string" }, "project_id": { "maxLength": 1024, "type": "string" }, "source_id": { "maxLength": 1024, "type": "string" } }, "required": [ "name", "project_id", "source_id", "event_types", "destination_revision_ids" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/routes/{id}": { "get": { "operationId": "get_api_v1_routes_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/routes/{id}/pause": { "post": { "operationId": "post_api_v1_routes_id_pause", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" } }, "required": [ "expected_revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/routes/{id}/preview": { "post": { "operationId": "post_api_v1_routes_id_preview", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "event_id": { "maxLength": 1024, "type": "string" }, "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/routes/{id}/resume": { "post": { "operationId": "post_api_v1_routes_id_resume", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" } }, "required": [ "expected_revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/routes/{id}/revisions": { "post": { "operationId": "post_api_v1_routes_id_revisions", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "destination_revision_ids": { "items": { "minLength": 1, "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array", "uniqueItems": true }, "event_types": { "items": { "enum": [ "checkout.session.completed", "checkout.session.async_payment_succeeded", "checkout.session.async_payment_failed", "checkout.session.expired", "customer.subscription.created", "customer.subscription.updated", "customer.subscription.deleted", "customer.subscription.trial_will_end", "customer.subscription.paused", "customer.subscription.resumed", "invoice.created", "invoice.finalized", "invoice.finalization_failed", "invoice.updated", "invoice.paid", "invoice.payment_failed", "invoice.payment_action_required", "invoice.voided", "invoice.marked_uncollectible" ], "type": "string" }, "maxItems": 19, "minItems": 1, "type": "array", "uniqueItems": true }, "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" } }, "required": [ "expected_revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/sources": { "get": { "operationId": "get_api_v1_sources", "parameters": [ { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "project_id", "schema": { "type": "string" } }, { "in": "query", "name": "source_id", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "after", "schema": { "type": "string" } }, { "in": "query", "name": "before", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 25, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": "string" } }, "required": [ "data", "next_cursor" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] }, "post": { "operationId": "post_api_v1_sources", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "account_id": { "maxLength": 1024, "type": "string" }, "api_version": { "enum": [ "2026-08-26.dahlia" ], "type": "string" }, "enabled_event_types": { "items": { "enum": [ "checkout.session.completed", "checkout.session.async_payment_succeeded", "checkout.session.async_payment_failed", "checkout.session.expired", "customer.subscription.created", "customer.subscription.updated", "customer.subscription.deleted", "customer.subscription.trial_will_end", "customer.subscription.paused", "customer.subscription.resumed", "invoice.created", "invoice.finalized", "invoice.finalization_failed", "invoice.updated", "invoice.paid", "invoice.payment_failed", "invoice.payment_action_required", "invoice.voided", "invoice.marked_uncollectible" ], "type": "string" }, "maxItems": 19, "minItems": 1, "type": "array", "uniqueItems": true }, "event_format": { "enum": [ "snapshot" ], "type": "string" }, "livemode": { "type": "boolean" }, "name": { "maxLength": 1024, "type": "string" }, "read_key": { "maxLength": 1024, "minLength": 12, "type": "string", "writeOnly": true }, "webhook_secret": { "maxLength": 1024, "minLength": 12, "type": "string", "writeOnly": true } }, "required": [ "name", "account_id", "livemode", "api_version", "event_format", "read_key", "webhook_secret", "enabled_event_types" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/sources/{id}": { "get": { "operationId": "get_api_v1_sources_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/sources/{id}/activate": { "post": { "operationId": "post_api_v1_sources_id_activate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "event_id": { "maxLength": 1024, "type": "string" }, "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" } }, "required": [ "expected_revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/sources/{id}/disable": { "post": { "operationId": "post_api_v1_sources_id_disable", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "confirmation": { "maxLength": 1024, "type": "string" }, "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" } }, "required": [ "expected_revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/sources/{id}/pause": { "post": { "operationId": "post_api_v1_sources_id_pause", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" } }, "required": [ "expected_revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/sources/{id}/resume": { "post": { "operationId": "post_api_v1_sources_id_resume", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" } }, "required": [ "expected_revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/sources/{id}/secrets/rotate": { "post": { "operationId": "post_api_v1_sources_id_secrets_rotate", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "overlap_seconds": { "maximum": 86400, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" }, "webhook_secret": { "maxLength": 1024, "minLength": 12, "type": "string", "writeOnly": true } }, "required": [ "expected_revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/sources/{id}/verify": { "post": { "operationId": "post_api_v1_sources_id_verify", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" } }, "required": [ "expected_revision" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/tokens": { "get": { "operationId": "get_api_v1_tokens", "parameters": [ { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "project_id", "schema": { "type": "string" } }, { "in": "query", "name": "source_id", "schema": { "type": "string" } }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "status", "schema": { "type": "string" } }, { "in": "query", "name": "after", "schema": { "type": "string" } }, { "in": "query", "name": "before", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 25, "maximum": 100, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": "string" } }, "required": [ "data", "next_cursor" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] }, "post": { "operationId": "post_api_v1_tokens", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "actor_label": { "maxLength": 1024, "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "project_ids": { "items": { "minLength": 1, "type": "string" }, "maxItems": 100, "minItems": 1, "type": "array", "uniqueItems": true }, "scopes": { "items": { "enum": [ "projects:read", "destinations:read", "destinations:write", "routes:read", "routes:write", "events:read", "payloads:read", "deliveries:read", "deliveries:replay" ], "type": "string" }, "minItems": 1, "type": "array", "uniqueItems": true } }, "required": [ "actor_label", "project_ids", "scopes" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/tokens/{id}": { "get": { "operationId": "get_api_v1_tokens_id", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "id": { "type": "string" }, "project_id": { "nullable": true, "type": "string" }, "relationship_resolution": { "type": "object" }, "revision": { "type": "integer" }, "state": { "type": "string" }, "tenant_id": { "type": "string" }, "version": { "type": "integer" } }, "required": [ "id" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/api/v1/tokens/{id}/revoke": { "post": { "operationId": "post_api_v1_tokens_id_revoke", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "minLength": 1, "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 200, "minLength": 8, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_revision": { "maximum": 2147483647, "minimum": 1, "type": "integer" }, "reason": { "maxLength": 1024, "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/billing/webhook": { "post": { "description": "Independent raw-byte Stripe signature verification and durable billing ledger. The success URL never grants access.", "operationId": "post_billing_webhook", "requestBody": { "content": { "application/json": { "schema": { "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } } } }, "/invite/{token}": { "post": { "operationId": "post_invite_token", "parameters": [ { "in": "path", "name": "token", "required": true, "schema": { "minLength": 32, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "password": { "maxLength": 1024, "minLength": 12, "type": "string", "writeOnly": true } }, "required": [ "password" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } } } }, "/login": { "post": { "operationId": "post_login", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "email": { "maxLength": 1024, "type": "string" }, "password": { "maxLength": 1024, "minLength": 12, "type": "string", "writeOnly": true } }, "required": [ "email", "password" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "required": [ "csrf_token" ], "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } } } }, "/logout": { "post": { "operationId": "post_logout", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": {}, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } }, "security": [ { "bearerAuth": [] }, { "sessionAuth": [] } ] } }, "/recover": { "post": { "operationId": "post_recover", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "email": { "maxLength": 1024, "type": "string" }, "password": { "maxLength": 1024, "minLength": 12, "type": "string", "writeOnly": true }, "recovery_code": { "maxLength": 1024, "minLength": 12, "type": "string", "writeOnly": true } }, "required": [ "email", "recovery_code", "password" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "accepted": { "type": "boolean" }, "endpoint_id": { "type": "string" }, "generation": { "type": "integer" }, "id": { "type": "string" }, "ingest_path": { "type": "string" }, "revision": { "type": "integer" }, "revision_id": { "type": "string" }, "secret": { "description": "Returned only for an authorized secret issue or its idempotent retry.", "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "integer" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } } } }, "/signup": { "post": { "operationId": "post_signup", "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "email": { "maxLength": 1024, "type": "string" }, "name": { "maxLength": 1024, "type": "string" }, "password": { "maxLength": 1024, "minLength": 12, "type": "string", "writeOnly": true } }, "required": [ "name", "email", "password" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "properties": { "recovery_code": { "type": "string" } }, "type": "object" } } }, "description": "The authorized result." }, "400": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "410": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "request_id": { "type": "string" } }, "required": [ "code", "message", "request_id" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The authorized result." } } } } }, "servers": [ { "url": "https://hookfork.com" } ] }