{ "components": { "schemas": { "ApplicationDefinition": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "type": "string" }, "description": { "type": [ "string", "null" ] }, "draft": { "additionalProperties": false, "properties": { "has_unpublished_changes": { "type": "boolean" }, "revision": { "minimum": 0, "type": "integer" }, "unpublished_change_count": { "minimum": 0, "type": "integer" } }, "required": [ "revision", "has_unpublished_changes", "unpublished_change_count" ], "type": "object" }, "id": { "pattern": "^appdef_[a-z0-9]+$", "type": "string" }, "is_shared": { "type": "boolean" }, "name": { "type": "string" }, "published": { "oneOf": [ { "type": "null" }, { "additionalProperties": false, "properties": { "published_at": { "format": "date-time", "type": "string" }, "version": { "minimum": 1, "type": "integer" } }, "required": [ "version", "published_at" ], "type": "object" } ] }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "id", "name", "description", "is_shared", "draft", "published", "created_at", "updated_at" ], "type": "object" }, "ApplicationDefinitionAssignment": { "additionalProperties": false, "properties": { "context": { "enum": [ "client", "deal" ], "type": "string" }, "definition": { "oneOf": [ { "type": "null" }, { "additionalProperties": false, "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "published_version": { "type": "integer" } }, "required": [ "id", "name", "published_version" ], "type": "object" } ] } }, "required": [ "context", "definition" ], "type": "object" }, "ApplicationDefinitionConfig": { "$id": "https://documentation.levr.ai/schemas/application-definition-config-v1.json", "$schema": "https://json-schema.org/draft/2020-12/schema", "additionalProperties": false, "properties": { "application_definition": { "additionalProperties": false, "properties": { "application_name": { "type": [ "string", "null" ] }, "blocks": { "items": { "additionalProperties": false, "allOf": [ { "if": { "properties": { "block_kind": { "const": "text" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "request": { "additionalProperties": false, "properties": { "description_json": { "additionalProperties": true, "type": "object" }, "fields": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "is_required": { "type": "boolean" }, "label": { "type": [ "string", "null" ] }, "schema_key": { "minLength": 1, "type": "string" }, "tooltip": { "type": [ "string", "null" ] } }, "required": [ "schema_key" ], "type": "object" } }, "required": [ "request" ], "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "long_text" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "request": { "additionalProperties": false, "properties": { "description_json": { "additionalProperties": true, "type": "object" }, "fields": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "is_required": { "type": "boolean" }, "label": { "type": [ "string", "null" ] }, "schema_key": { "minLength": 1, "type": "string" }, "tooltip": { "type": [ "string", "null" ] } }, "required": [ "schema_key" ], "type": "object" } }, "required": [ "request" ], "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "integer" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "request": { "additionalProperties": false, "properties": { "description_json": { "additionalProperties": true, "type": "object" }, "fields": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "is_required": { "type": "boolean" }, "label": { "type": [ "string", "null" ] }, "schema_key": { "minLength": 1, "type": "string" }, "tooltip": { "type": [ "string", "null" ] } }, "required": [ "schema_key" ], "type": "object" } }, "required": [ "request" ], "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "decimal" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "request": { "additionalProperties": false, "properties": { "description_json": { "additionalProperties": true, "type": "object" }, "fields": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "is_required": { "type": "boolean" }, "label": { "type": [ "string", "null" ] }, "schema_key": { "minLength": 1, "type": "string" }, "tooltip": { "type": [ "string", "null" ] } }, "required": [ "schema_key" ], "type": "object" } }, "required": [ "request" ], "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "boolean" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "request": { "additionalProperties": false, "properties": { "description_json": { "additionalProperties": true, "type": "object" }, "fields": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "is_required": { "type": "boolean" }, "label": { "type": [ "string", "null" ] }, "schema_key": { "minLength": 1, "type": "string" }, "tooltip": { "type": [ "string", "null" ] } }, "required": [ "schema_key" ], "type": "object" } }, "required": [ "request" ], "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "dropdown" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "request": { "additionalProperties": false, "properties": { "description_json": { "additionalProperties": true, "type": "object" }, "fields": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "is_required": { "type": "boolean" }, "label": { "type": [ "string", "null" ] }, "schema_key": { "minLength": 1, "type": "string" }, "tooltip": { "type": [ "string", "null" ] } }, "required": [ "schema_key" ], "type": "object" } }, "required": [ "request" ], "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "multiselect" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "request": { "additionalProperties": false, "properties": { "description_json": { "additionalProperties": true, "type": "object" }, "fields": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "is_required": { "type": "boolean" }, "label": { "type": [ "string", "null" ] }, "schema_key": { "minLength": 1, "type": "string" }, "tooltip": { "type": [ "string", "null" ] } }, "required": [ "schema_key" ], "type": "object" } }, "required": [ "request" ], "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "catalog_select" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "catalog": { "additionalProperties": false, "properties": { "entries": { "items": { "additionalProperties": false, "properties": { "aliases": { "items": { "type": "string" }, "type": "array" }, "label": { "type": "string" }, "value": { "type": "string" } }, "required": [ "value", "label" ], "type": "object" }, "type": "array" } }, "required": [ "entries" ], "type": "object" }, "request": { "additionalProperties": false, "properties": { "description_json": { "additionalProperties": true, "type": "object" }, "fields": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "is_required": { "type": "boolean" }, "label": { "type": [ "string", "null" ] }, "schema_key": { "minLength": 1, "type": "string" }, "tooltip": { "type": [ "string", "null" ] } }, "required": [ "schema_key" ], "type": "object" } }, "required": [ "catalog", "request" ], "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "date" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "request": { "additionalProperties": false, "properties": { "description_json": { "additionalProperties": true, "type": "object" }, "fields": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "is_required": { "type": "boolean" }, "label": { "type": [ "string", "null" ] }, "schema_key": { "minLength": 1, "type": "string" }, "tooltip": { "type": [ "string", "null" ] } }, "required": [ "schema_key" ], "type": "object" } }, "required": [ "request" ], "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "datetime" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "request": { "additionalProperties": false, "properties": { "description_json": { "additionalProperties": true, "type": "object" }, "fields": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "is_required": { "type": "boolean" }, "label": { "type": [ "string", "null" ] }, "schema_key": { "minLength": 1, "type": "string" }, "tooltip": { "type": [ "string", "null" ] } }, "required": [ "schema_key" ], "type": "object" } }, "required": [ "request" ], "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "email" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "request": { "additionalProperties": false, "properties": { "description_json": { "additionalProperties": true, "type": "object" }, "fields": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "is_required": { "type": "boolean" }, "label": { "type": [ "string", "null" ] }, "schema_key": { "minLength": 1, "type": "string" }, "tooltip": { "type": [ "string", "null" ] } }, "required": [ "schema_key" ], "type": "object" } }, "required": [ "request" ], "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "url" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "request": { "additionalProperties": false, "properties": { "description_json": { "additionalProperties": true, "type": "object" }, "fields": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "is_required": { "type": "boolean" }, "label": { "type": [ "string", "null" ] }, "schema_key": { "minLength": 1, "type": "string" }, "tooltip": { "type": [ "string", "null" ] } }, "required": [ "schema_key" ], "type": "object" } }, "required": [ "request" ], "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "address" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "request": { "additionalProperties": false, "properties": { "description_json": { "additionalProperties": true, "type": "object" }, "fields": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "is_required": { "type": "boolean" }, "label": { "type": [ "string", "null" ] }, "schema_key": { "minLength": 1, "type": "string" }, "tooltip": { "type": [ "string", "null" ] } }, "required": [ "schema_key" ], "type": "object" } }, "required": [ "request" ], "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "file" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "request": { "additionalProperties": false, "properties": { "description_json": { "additionalProperties": true, "type": "object" }, "fields": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "is_required": { "type": "boolean" }, "label": { "type": [ "string", "null" ] }, "schema_key": { "minLength": 1, "type": "string" }, "tooltip": { "type": [ "string", "null" ] } }, "required": [ "schema_key" ], "type": "object" } }, "required": [ "request" ], "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "signature" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "request": { "additionalProperties": false, "properties": { "description_json": { "additionalProperties": true, "type": "object" }, "fields": { "items": { "additionalProperties": true, "type": "object" }, "type": "array" }, "is_required": { "type": "boolean" }, "label": { "type": [ "string", "null" ] }, "schema_key": { "minLength": 1, "type": "string" }, "tooltip": { "type": [ "string", "null" ] } }, "required": [ "schema_key" ], "type": "object" } }, "required": [ "request" ], "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "group" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "label": { "type": [ "string", "null" ] }, "tooltip": { "type": [ "string", "null" ] } }, "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "list" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "initialize_empty_item": { "type": "boolean" }, "label": { "type": [ "string", "null" ] }, "max_items": { "type": [ "integer", "null" ] }, "min_items": { "type": [ "integer", "null" ] }, "tooltip": { "type": [ "string", "null" ] } }, "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "heading" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "copy": { "additionalProperties": false, "properties": { "text": { "type": [ "string", "null" ] } }, "type": "object" }, "presentation": { "additionalProperties": false, "properties": { "align": { "type": [ "string", "null" ] }, "level": { "type": [ "string", "null" ] }, "max_width": { "type": [ "string", "null" ] }, "tone": { "type": [ "string", "null" ] } }, "type": "object" } }, "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "paragraph" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "copy": { "additionalProperties": false, "properties": { "body_text": { "type": [ "string", "null" ] } }, "type": "object" } }, "type": "object" } } } }, { "if": { "properties": { "block_kind": { "const": "banner" } }, "required": [ "block_kind" ] }, "then": { "properties": { "config": { "additionalProperties": false, "properties": { "copy": { "additionalProperties": false, "properties": { "body_text": { "type": [ "string", "null" ] }, "title_text": { "type": [ "string", "null" ] } }, "type": "object" }, "presentation": { "additionalProperties": false, "properties": { "tone": { "type": [ "string", "null" ] } }, "type": "object" } }, "type": "object" } } } }, { "if": { "properties": { "config_source": { "const": "inline" } } }, "then": { "required": [ "config" ] } }, { "if": { "properties": { "config_source": { "const": "reusable_block" } } }, "then": { "required": [ "reusable_block_reference" ] } } ], "properties": { "block_kind": { "enum": [ "text", "long_text", "integer", "decimal", "boolean", "dropdown", "multiselect", "catalog_select", "date", "datetime", "email", "url", "address", "file", "signature", "group", "list", "heading", "paragraph", "banner" ], "type": "string" }, "config": { "type": "object" }, "config_source": { "enum": [ "inline", "reusable_block" ], "type": "string" }, "order_within_parent": { "type": "integer" }, "parent_stable_block_id": { "type": [ "string", "null" ] }, "reusable_block_reference": { "additionalProperties": false, "properties": { "asset_key": { "minLength": 1, "type": "string" }, "source_kind": { "enum": [ "common", "provider_owner" ], "type": "string" } }, "required": [ "source_kind", "asset_key" ], "type": "object" }, "section_key": { "minLength": 1, "type": "string" }, "slot_name": { "type": [ "string", "null" ] }, "stable_block_id": { "type": [ "string", "null" ] }, "visibility_rules": { "type": "object" } }, "required": [ "block_kind", "section_key", "config_source" ], "type": "object" }, "type": "array" }, "description": { "type": [ "string", "null" ] }, "is_shared": { "type": "boolean" }, "sections": { "items": { "additionalProperties": false, "properties": { "section_key": { "minLength": 1, "type": "string" }, "section_label": { "type": [ "string", "null" ] }, "section_order": { "type": "integer" } }, "required": [ "section_key" ], "type": "object" }, "minItems": 1, "type": "array" } }, "required": [ "sections" ], "type": "object" }, "config_type": { "const": "application_definition", "type": "string" }, "config_version": { "const": 1, "type": "integer" } }, "required": [ "config_version", "config_type", "application_definition" ], "title": "Levr Application Definition Config", "type": "object" }, "ApplicationDefinitionConfigEnvelope": { "additionalProperties": false, "properties": { "config": { "$ref": "#/components/schemas/ApplicationDefinitionConfig" }, "definition_id": { "pattern": "^appdef_[a-z0-9]+$", "type": "string" }, "digest": { "type": "string" }, "revision": { "type": "integer" }, "state": { "const": "draft", "type": "string" } }, "required": [ "definition_id", "revision", "digest", "config", "state" ], "type": "object" }, "ApplicationDefinitionMutation": { "additionalProperties": false, "properties": { "definition_id": { "type": "string" }, "revision": { "type": "integer" } }, "required": [ "definition_id", "revision" ], "type": "object" }, "ApplicationDefinitionPage": { "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/ApplicationDefinition" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "previous_cursor": { "type": [ "string", "null" ] } }, "required": [ "items", "next_cursor", "previous_cursor" ], "type": "object" }, "ApplicationDefinitionPublishReview": { "additionalProperties": false, "properties": { "change_summary": { "type": "object" }, "changed_section_keys": { "items": { "type": "string" }, "type": "array" }, "definition_id": { "type": "string" }, "draft_block_count": { "type": "integer" }, "draft_revision": { "type": "integer" }, "has_unpublished_changes": { "type": "boolean" }, "impact_summary": { "type": "object" }, "is_initial_publish": { "type": "boolean" }, "latest_published_version": { "type": [ "integer", "null" ] }, "review_digest": { "maxLength": 64, "minLength": 64, "type": "string" } }, "required": [ "definition_id", "draft_revision", "latest_published_version", "is_initial_publish", "draft_block_count", "has_unpublished_changes", "changed_section_keys", "change_summary", "impact_summary", "review_digest" ], "type": "object" }, "BusinessCreateResult": { "additionalProperties": false, "properties": { "application_id": { "type": "string" }, "business": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "status_url": { "format": "uri", "type": "string" } }, "required": [ "id", "name", "status_url" ], "type": "object" }, "file_uploads": { "items": { "additionalProperties": false, "properties": { "multiple": { "type": "boolean" }, "request_path": { "type": "string" }, "upload_url": { "format": "uri", "type": "string" } }, "required": [ "request_path", "upload_url", "multiple" ], "type": "object" }, "type": "array" }, "invitation_url": { "format": "uri", "type": [ "string", "null" ] }, "warnings": { "items": { "type": "object" }, "type": "array" } }, "required": [ "business", "application_id", "invitation_url", "file_uploads", "warnings" ], "type": "object" }, "BusinessFileUploadResult": { "additionalProperties": false, "properties": { "application_file_bytes": { "type": "integer" }, "application_file_count": { "type": "integer" }, "filename": { "type": "string" }, "request_path": { "type": "string" }, "size": { "type": "integer" } }, "required": [ "request_path", "filename", "size", "application_file_count", "application_file_bytes" ], "type": "object" }, "BusinessPage": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "id": { "pattern": "^org_[a-z0-9]+$", "type": "string" }, "name": { "type": [ "string", "null" ] }, "status_url": { "format": "uri", "type": "string" } }, "required": [ "id", "name", "status_url" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "previous_cursor": { "type": [ "string", "null" ] } }, "required": [ "items", "next_cursor", "previous_cursor" ], "type": "object" }, "BusinessStatusResult": { "additionalProperties": false, "properties": { "business": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "status": { "additionalProperties": false, "properties": { "pipeline": { "type": "string" }, "stage": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "pipeline", "stage", "updated_at" ], "type": "object" } }, "required": [ "id", "name", "status" ], "type": "object" } }, "required": [ "business" ], "type": "object" }, "ExternalApiError": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" }, "PublishedApplicationDefinitionConfigEnvelope": { "additionalProperties": false, "properties": { "config": { "$ref": "#/components/schemas/ApplicationDefinitionConfig" }, "definition_id": { "pattern": "^appdef_[a-z0-9]+$", "type": "string" }, "digest": { "type": "string" }, "state": { "const": "published", "type": "string" }, "version": { "minimum": 1, "type": "integer" } }, "required": [ "definition_id", "state", "version", "digest", "config" ], "type": "object" }, "SourceChannelBusinessContract": { "additionalProperties": false, "properties": { "contract_version": { "type": "integer" }, "create_business_url": { "format": "uri", "type": "string" }, "request_schema": { "type": "object" }, "source_channel": { "additionalProperties": false, "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "type": "object" } }, "required": [ "source_channel", "contract_version", "request_schema", "create_business_url" ], "type": "object" }, "SourceChannelPage": { "additionalProperties": false, "properties": { "items": { "items": { "additionalProperties": false, "properties": { "business_contract_url": { "format": "uri", "type": "string" }, "create_business_url": { "format": "uri", "type": "string" }, "id": { "pattern": "^srcch_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" }, "readiness": { "additionalProperties": false, "properties": { "is_ready": { "type": "boolean" }, "message": { "type": "string" }, "reason": { "type": [ "string", "null" ] } }, "required": [ "is_ready", "reason", "message" ], "type": "object" } }, "required": [ "id", "name", "readiness", "business_contract_url", "create_business_url" ], "type": "object" }, "type": "array" }, "next_cursor": { "type": [ "string", "null" ] }, "previous_cursor": { "type": [ "string", "null" ] } }, "required": [ "items", "next_cursor", "previous_cursor" ], "type": "object" } }, "securitySchemes": { "providerApiToken": { "bearerFormat": "Portal API Token", "scheme": "bearer", "type": "http" } } }, "info": { "description": "Portal-scoped access to Levr resources and signed domain events.", "title": "Levr External API", "version": "1.0.0" }, "openapi": "3.1.0", "paths": { "/application-definition-config-schema/": { "get": { "operationId": "getApplicationDefinitionConfigSchema", "parameters": [], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Get the standalone config JSON Schema" } }, "/application-definition-defaults/{context}/": { "get": { "operationId": "getDefaultApplicationDefinition", "parameters": [ { "in": "path", "name": "context", "required": true, "schema": { "enum": [ "client", "deal" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationDefinitionAssignment" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Get the default client or deal application" }, "put": { "operationId": "setDefaultApplicationDefinition", "parameters": [ { "in": "path", "name": "context", "required": true, "schema": { "enum": [ "client", "deal" ], "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "definition_id": { "pattern": "^appdef_[a-z0-9]+$", "type": "string" } }, "required": [ "definition_id" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationDefinitionAssignment" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "409": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "422": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Set the default client or deal application" } }, "/application-definitions/": { "get": { "operationId": "listApplicationDefinitions", "parameters": [ { "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "Comma-separated name, created_at, or updated_at; prefix - for descending.", "in": "query", "name": "ordering", "schema": { "type": "string" } }, { "in": "query", "name": "published", "schema": { "type": "boolean" } }, { "in": "query", "name": "is_shared", "schema": { "type": "boolean" } }, { "in": "query", "name": "created_after", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "created_before", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "updated_after", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "updated_before", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationDefinitionPage" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "List application definitions" }, "post": { "operationId": "createApplicationDefinition", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "config": { "$ref": "#/components/schemas/ApplicationDefinitionConfig" } }, "required": [ "config" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationDefinition" } } }, "description": "Created" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "409": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "422": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Create an application definition from a complete config" } }, "/application-definitions/{definition_slug}/": { "get": { "operationId": "getApplicationDefinition", "parameters": [ { "in": "path", "name": "definition_slug", "required": true, "schema": { "pattern": "^appdef_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationDefinition" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Get an application definition" }, "patch": { "operationId": "updateApplicationDefinitionMetadata", "parameters": [ { "in": "path", "name": "definition_slug", "required": true, "schema": { "pattern": "^appdef_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "name": { "type": "string" } }, "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationDefinition" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "409": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "412": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Update editable definition metadata" } }, "/application-definitions/{definition_slug}/blocks/{stable_block_id}/attachment/": { "delete": { "operationId": "deleteApplicationDefinitionAttachment", "parameters": [ { "in": "path", "name": "definition_slug", "required": true, "schema": { "pattern": "^appdef_[a-z0-9]+$", "type": "string" } }, { "in": "path", "name": "stable_block_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationDefinitionMutation" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "409": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "412": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Delete a block attachment" }, "get": { "operationId": "downloadApplicationDefinitionAttachment", "parameters": [ { "in": "path", "name": "definition_slug", "required": true, "schema": { "pattern": "^appdef_[a-z0-9]+$", "type": "string" } }, { "in": "path", "name": "stable_block_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/pdf": { "schema": { "format": "binary", "type": "string" } } }, "description": "Attachment bytes" }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Download a block attachment" }, "put": { "operationId": "uploadApplicationDefinitionAttachment", "parameters": [ { "in": "path", "name": "definition_slug", "required": true, "schema": { "pattern": "^appdef_[a-z0-9]+$", "type": "string" } }, { "in": "path", "name": "stable_block_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "additionalProperties": false, "properties": { "attachment": { "format": "binary", "type": "string" } }, "required": [ "attachment" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationDefinitionMutation" } } }, "description": "Updated" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "409": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "412": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "413": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "422": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Upload a block attachment" } }, "/application-definitions/{definition_slug}/config-validation/": { "post": { "operationId": "validateApplicationDefinitionConfig", "parameters": [ { "in": "path", "name": "definition_slug", "required": true, "schema": { "pattern": "^appdef_[a-z0-9]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "config": { "$ref": "#/components/schemas/ApplicationDefinitionConfig" } }, "required": [ "config" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "digest": { "type": "string" }, "valid": { "const": true, "type": "boolean" } }, "required": [ "valid", "digest" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "422": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Validate a complete config without changing data" } }, "/application-definitions/{definition_slug}/config/": { "get": { "operationId": "getApplicationDefinitionConfig", "parameters": [ { "in": "path", "name": "definition_slug", "required": true, "schema": { "pattern": "^appdef_[a-z0-9]+$", "type": "string" } }, { "in": "query", "name": "state", "schema": { "enum": [ "draft", "published" ], "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ApplicationDefinitionConfigEnvelope" }, { "$ref": "#/components/schemas/PublishedApplicationDefinitionConfigEnvelope" } ] } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Get draft or published config" }, "put": { "operationId": "replaceApplicationDefinitionConfig", "parameters": [ { "in": "path", "name": "definition_slug", "required": true, "schema": { "pattern": "^appdef_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "config": { "$ref": "#/components/schemas/ApplicationDefinitionConfig" } }, "required": [ "config" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationDefinitionConfigEnvelope" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "409": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "412": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "422": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Replace the complete draft config" } }, "/application-definitions/{definition_slug}/publish-review/": { "get": { "operationId": "reviewApplicationDefinitionPublish", "parameters": [ { "in": "path", "name": "definition_slug", "required": true, "schema": { "pattern": "^appdef_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationDefinitionPublishReview" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Review the exact draft before publishing" } }, "/application-definitions/{definition_slug}/publish/": { "post": { "operationId": "publishApplicationDefinition", "parameters": [ { "in": "path", "name": "definition_slug", "required": true, "schema": { "pattern": "^appdef_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "If-Match", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "review_digest": { "maxLength": 64, "minLength": 64, "type": "string" } }, "required": [ "review_digest" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "definition_id": { "type": "string" }, "published_at": { "format": "date-time", "type": "string" }, "published_version": { "type": "integer" } }, "required": [ "definition_id", "published_version", "published_at" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "409": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "412": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "422": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Publish the reviewed draft" } }, "/application-definitions/{definition_slug}/sharing/": { "post": { "operationId": "reviewApplicationDefinitionSharing", "parameters": [ { "in": "path", "name": "definition_slug", "required": true, "schema": { "pattern": "^appdef_[a-z0-9]+$", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "is_shared": { "type": "boolean" } }, "required": [ "is_shared" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "affected_provider_count": { "type": "integer" }, "blockers": { "items": { "type": "string" }, "type": "array" }, "impact_version": { "type": "string" } }, "required": [ "impact_version", "affected_provider_count", "blockers" ], "type": "object" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "422": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Review a sharing or privacy change" }, "put": { "operationId": "updateApplicationDefinitionSharing", "parameters": [ { "in": "path", "name": "definition_slug", "required": true, "schema": { "pattern": "^appdef_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "expected_impact_version": { "type": "string" }, "is_shared": { "type": "boolean" } }, "required": [ "is_shared", "expected_impact_version" ], "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplicationDefinition" } } }, "description": "Success" }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "409": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "422": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Apply a reviewed sharing or privacy change" } }, "/businesses/": { "get": { "operationId": "listBusinesses", "parameters": [ { "description": "Match a business name or operating name.", "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "Comma-separated name, created_at, or updated_at; prefix - for descending.", "in": "query", "name": "ordering", "schema": { "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "created_after", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "created_before", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "updated_after", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "updated_before", "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessPage" } } }, "description": "Businesses available to this portal API token." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "List businesses" } }, "/businesses/{business_id}/": { "get": { "operationId": "getBusinessStatus", "parameters": [ { "in": "path", "name": "business_id", "required": true, "schema": { "pattern": "^org_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessStatusResult" } } }, "description": "The business status visible in this portal." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "409": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Get a business and its portal status" } }, "/source-channels/": { "get": { "operationId": "listBusinessSourceChannels", "parameters": [ { "in": "query", "name": "search", "schema": { "type": "string" } }, { "description": "Comma-separated name, created_at, or updated_at; prefix - for descending.", "in": "query", "name": "ordering", "schema": { "type": "string" } }, { "in": "query", "name": "page_size", "schema": { "maximum": 100, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "cursor", "schema": { "type": "string" } }, { "in": "query", "name": "created_after", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "created_before", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "updated_after", "schema": { "format": "date-time", "type": "string" } }, { "in": "query", "name": "updated_before", "schema": { "format": "date-time", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceChannelPage" } } }, "description": "Source channels available to this portal and their contract URLs." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "List API source channels available for business submissions" } }, "/source-channels/{source_channel_id}/business-contract/": { "get": { "operationId": "getSourceChannelBusinessContract", "parameters": [ { "in": "path", "name": "source_channel_id", "required": true, "schema": { "pattern": "^srcch_[a-z0-9]+$", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceChannelBusinessContract" } } }, "description": "The channel's current published JSON Schema and submission URL." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "409": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Get the current dynamic business submission contract" } }, "/source-channels/{source_channel_id}/business-files/{upload_id}/": { "post": { "description": "Use only the expiring upload URL returned by business creation.", "operationId": "uploadBusinessSubmissionFile", "parameters": [ { "in": "path", "name": "source_channel_id", "required": true, "schema": { "pattern": "^srcch_[a-z0-9]+$", "type": "string" } }, { "in": "path", "name": "upload_id", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "type": "string" } } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "additionalProperties": false, "properties": { "file": { "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessFileUploadResult" } } }, "description": "File stored on the requested application field." }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "409": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "413": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Upload a file requested by a successful business submission" } }, "/source-channels/{source_channel_id}/businesses/": { "post": { "description": "Fetch this channel's business-contract endpoint before constructing the request body. Matching Idempotency-Key retries replay the exact committed response for at least 24 hours.", "operationId": "createSourceChannelBusiness", "parameters": [ { "in": "path", "name": "source_channel_id", "required": true, "schema": { "pattern": "^srcch_[a-z0-9]+$", "type": "string" } }, { "in": "header", "name": "Idempotency-Key", "required": true, "schema": { "maxLength": 255, "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "description": "The exact schema is returned by the source channel's business-contract endpoint.", "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BusinessCreateResult" } } }, "description": "Business and client intake application created." }, "400": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "401": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "403": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "404": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "409": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "422": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "429": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." }, "500": { "content": { "application/json": { "schema": { "additionalProperties": false, "properties": { "error": { "additionalProperties": false, "properties": { "code": { "type": "string" }, "documentation_url": { "format": "uri", "type": "string" }, "field_errors": { "type": "object" }, "message": { "type": "string" }, "request_id": { "pattern": "^req_[a-z0-9]+$", "type": "string" } }, "required": [ "code", "message", "field_errors", "request_id", "documentation_url" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "The request was not completed." } }, "summary": "Create a business through an API source channel" } } }, "security": [ { "providerApiToken": [] } ], "servers": [ { "url": "https://api.staging.levr.ai/api/external/v1" } ], "webhooks": { "business_status_changed": { "post": { "description": "A business moved to a different stage in the portal pipeline. Verify Levr-Signature against the unmodified request body before processing.", "operationId": "business_status_changed_webhook", "parameters": [ { "in": "header", "name": "Levr-Event-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Delivery-ID", "required": true, "schema": { "type": "string" } }, { "in": "header", "name": "Levr-Signature", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "api_version": "v1", "created_at": "2026-08-19T16:42:13Z", "data": { "business": { "id": "org_7fj3k9m2d8q4n6wx", "name": "Example Analytics Inc.", "status": { "changed_at": "2026-08-19T16:42:13Z", "pipeline": "Clients", "stage": "Underwriting" } } }, "id": "evt_2m8q7c9k4x6p3n5d", "type": "business.status_changed" }, "schema": { "additionalProperties": false, "properties": { "api_version": { "const": "v1", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "data": { "additionalProperties": false, "properties": { "business": { "additionalProperties": false, "properties": { "id": { "pattern": "^org_[a-z0-9]+$", "type": "string" }, "name": { "type": "string" }, "status": { "additionalProperties": false, "properties": { "changed_at": { "format": "date-time", "type": "string" }, "pipeline": { "type": "string" }, "stage": { "type": "string" } }, "required": [ "pipeline", "stage", "changed_at" ], "type": "object" } }, "required": [ "id", "name", "status" ], "type": "object" } }, "required": [ "business" ], "type": "object" }, "id": { "pattern": "^evt_[a-z0-9]+$", "type": "string" }, "type": { "const": "business.status_changed", "type": "string" } }, "required": [ "id", "type", "api_version", "created_at", "data" ], "type": "object" } } }, "required": true }, "responses": { "200": { "description": "The event was accepted." } }, "summary": "Business status changed" } } } }