{ "components": { "schemas": { "CatalogItem": { "properties": { "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "name": { "title": "Name", "type": "string" }, "slug": { "title": "Slug", "type": "string" } }, "required": [ "slug", "name" ], "title": "CatalogItem", "type": "object" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "title": "Detail", "type": "array" } }, "title": "HTTPValidationError", "type": "object" }, "HealthResponse": { "properties": { "service": { "title": "Service", "type": "string" }, "status": { "title": "Status", "type": "string" }, "version": { "title": "Version", "type": "string" } }, "required": [ "service", "status", "version" ], "title": "HealthResponse", "type": "object" }, "ReadinessResponse": { "properties": { "checks": { "additionalProperties": { "type": "string" }, "title": "Checks", "type": "object" }, "service": { "title": "Service", "type": "string" }, "status": { "title": "Status", "type": "string" } }, "required": [ "service", "status", "checks" ], "title": "ReadinessResponse", "type": "object" }, "ValidationError": { "properties": { "ctx": { "title": "Context", "type": "object" }, "input": { "title": "Input" }, "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "title": "Location", "type": "array" }, "msg": { "title": "Message", "type": "string" }, "type": { "title": "Error Type", "type": "string" } }, "required": [ "loc", "msg", "type" ], "title": "ValidationError", "type": "object" } } }, "info": { "description": "Third-generation production interaction framework API.", "title": "Core Hub API", "version": "0.1.0" }, "openapi": "3.1.0", "paths": { "/api/v2/annotation-categories": { "get": { "operationId": "list_annotation_categories_api_v2_annotation_categories_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CatalogItem" }, "title": "Response List Annotation Categories Api V2 Annotation Categories Get", "type": "array" } } }, "description": "Successful Response" } }, "summary": "List Annotation Categories", "tags": [ "api-v2" ] } }, "/api/v2/annotations": { "get": { "operationId": "deferred_collection_api_v2_annotations_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "items": {}, "type": "array" }, "title": "Response Deferred Collection Api V2 Annotations Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Deferred Collection", "tags": [ "api-v2" ] }, "post": { "operationId": "deferred_collection_api_v2_annotations_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": { "items": {}, "type": "array" }, "title": "Response Deferred Collection Api V2 Annotations Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Deferred Collection", "tags": [ "api-v2" ] } }, "/api/v2/api-consumers": { "get": { "operationId": "list_api_consumers_api_v2_api_consumers_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response List Api Consumers Api V2 Api Consumers Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Api Consumers", "tags": [ "api-v2" ] }, "post": { "operationId": "create_api_consumer_api_v2_api_consumers_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Body", "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Create Api Consumer Api V2 Api Consumers Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Api Consumer", "tags": [ "api-v2" ] } }, "/api/v2/api-consumers/{consumer_id}/api-keys": { "post": { "operationId": "create_api_key_api_v2_api_consumers__consumer_id__api_keys_post", "parameters": [ { "in": "path", "name": "consumer_id", "required": true, "schema": { "title": "Consumer Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Body", "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Create Api Key Api V2 Api Consumers Consumer Id Api Keys Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Api Key", "tags": [ "api-v2" ] } }, "/api/v2/decision-records": { "get": { "operationId": "deferred_collection_api_v2_decision_records_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "items": {}, "type": "array" }, "title": "Response Deferred Collection Api V2 Decision Records Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Deferred Collection", "tags": [ "api-v2" ] }, "post": { "operationId": "deferred_collection_api_v2_decision_records_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": { "items": {}, "type": "array" }, "title": "Response Deferred Collection Api V2 Decision Records Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Deferred Collection", "tags": [ "api-v2" ] } }, "/api/v2/deployment-records": { "get": { "operationId": "deferred_collection_api_v2_deployment_records_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "items": {}, "type": "array" }, "title": "Response Deferred Collection Api V2 Deployment Records Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Deferred Collection", "tags": [ "api-v2" ] }, "post": { "operationId": "deferred_collection_api_v2_deployment_records_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": { "items": {}, "type": "array" }, "title": "Response Deferred Collection Api V2 Deployment Records Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Deferred Collection", "tags": [ "api-v2" ] } }, "/api/v2/event-types": { "get": { "operationId": "list_event_types_api_v2_event_types_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CatalogItem" }, "title": "Response List Event Types Api V2 Event Types Get", "type": "array" } } }, "description": "Successful Response" } }, "summary": "List Event Types", "tags": [ "api-v2" ] } }, "/api/v2/hub-capability-manifests": { "get": { "operationId": "list_hub_capability_manifests_api_v2_hub_capability_manifests_get", "parameters": [ { "in": "query", "name": "hubId", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Hubid" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response List Hub Capability Manifests Api V2 Hub Capability Manifests Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Hub Capability Manifests", "tags": [ "api-v2" ] }, "post": { "operationId": "create_hub_capability_manifest_api_v2_hub_capability_manifests_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Body", "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Create Hub Capability Manifest Api V2 Hub Capability Manifests Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Hub Capability Manifest", "tags": [ "api-v2" ] } }, "/api/v2/hub-capability-manifests/{manifest_id}": { "patch": { "operationId": "update_hub_capability_manifest_api_v2_hub_capability_manifests__manifest_id__patch", "parameters": [ { "in": "path", "name": "manifest_id", "required": true, "schema": { "title": "Manifest Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Body", "type": "object" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Update Hub Capability Manifest Api V2 Hub Capability Manifests Manifest Id Patch", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Update Hub Capability Manifest", "tags": [ "api-v2" ] } }, "/api/v2/hub-capability-manifests/{manifest_id}/activate": { "post": { "operationId": "activate_hub_capability_manifest_api_v2_hub_capability_manifests__manifest_id__activate_post", "parameters": [ { "in": "path", "name": "manifest_id", "required": true, "schema": { "title": "Manifest Id", "type": "string" } }, { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Activate Hub Capability Manifest Api V2 Hub Capability Manifests Manifest Id Activate Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Activate Hub Capability Manifest", "tags": [ "api-v2" ] } }, "/api/v2/hub-registry": { "get": { "operationId": "hub_registry_api_v2_hub_registry_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Hub Registry Api V2 Hub Registry Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Hub Registry", "tags": [ "api-v2" ] } }, "/api/v2/hubs": { "get": { "operationId": "list_hubs_api_v2_hubs_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response List Hubs Api V2 Hubs Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Hubs", "tags": [ "api-v2" ] }, "post": { "operationId": "create_hub_api_v2_hubs_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Body", "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Create Hub Api V2 Hubs Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Hub", "tags": [ "api-v2" ] } }, "/api/v2/interaction-events": { "get": { "operationId": "list_interaction_events_api_v2_interaction_events_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response List Interaction Events Api V2 Interaction Events Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Interaction Events", "tags": [ "api-v2" ] }, "post": { "operationId": "create_interaction_event_api_v2_interaction_events_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Body", "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Create Interaction Event Api V2 Interaction Events Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Interaction Event", "tags": [ "api-v2" ] } }, "/api/v2/outcome-signals": { "get": { "operationId": "deferred_collection_api_v2_outcome_signals_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "items": {}, "type": "array" }, "title": "Response Deferred Collection Api V2 Outcome Signals Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Deferred Collection", "tags": [ "api-v2" ] }, "post": { "operationId": "deferred_collection_api_v2_outcome_signals_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": { "items": {}, "type": "array" }, "title": "Response Deferred Collection Api V2 Outcome Signals Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Deferred Collection", "tags": [ "api-v2" ] } }, "/api/v2/policy-scopes": { "get": { "operationId": "list_policy_scopes_api_v2_policy_scopes_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CatalogItem" }, "title": "Response List Policy Scopes Api V2 Policy Scopes Get", "type": "array" } } }, "description": "Successful Response" } }, "summary": "List Policy Scopes", "tags": [ "api-v2" ] } }, "/api/v2/requirement-candidates": { "get": { "operationId": "deferred_collection_api_v2_requirement_candidates_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "items": {}, "type": "array" }, "title": "Response Deferred Collection Api V2 Requirement Candidates Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Deferred Collection", "tags": [ "api-v2" ] }, "post": { "operationId": "deferred_collection_api_v2_requirement_candidates_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": { "items": {}, "type": "array" }, "title": "Response Deferred Collection Api V2 Requirement Candidates Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Deferred Collection", "tags": [ "api-v2" ] } }, "/api/v2/token": { "post": { "operationId": "post_token", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "string" }, "title": "Response Post Token", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Issue Token", "tags": [ "api-v2", "api-v2-protected" ] } }, "/api/v2/widget-types": { "get": { "operationId": "list_widget_types_api_v2_widget_types_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/CatalogItem" }, "title": "Response List Widget Types Api V2 Widget Types Get", "type": "array" } } }, "description": "Successful Response" } }, "summary": "List Widget Types", "tags": [ "api-v2" ] } }, "/api/v2/widgets": { "get": { "operationId": "list_widgets_api_v2_widgets_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response List Widgets Api V2 Widgets Get", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "List Widgets", "tags": [ "api-v2" ] }, "post": { "operationId": "create_widget_api_v2_widgets_post", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "requestBody": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Body", "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "additionalProperties": true, "title": "Response Create Widget Api V2 Widgets Post", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Create Widget", "tags": [ "api-v2" ] } }, "/console": { "get": { "operationId": "operator_console_console_get", "parameters": [ { "in": "header", "name": "authorization", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Authorization" } } ], "responses": { "200": { "content": { "text/html": { "schema": { "type": "string" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Operator Console", "tags": [ "operator-console" ] } }, "/healthz": { "get": { "operationId": "healthz_healthz_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HealthResponse" } } }, "description": "Successful Response" } }, "summary": "Healthz", "tags": [ "system" ] } }, "/readyz": { "get": { "operationId": "readyz_readyz_get", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReadinessResponse" } } }, "description": "Successful Response" } }, "summary": "Readyz", "tags": [ "system" ] } } } }