{ "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" }, "HubCapabilityManifest": { "properties": { "capabilities": { "items": { "type": "string" }, "title": "Capabilities", "type": "array" }, "endpoints": { "items": { "$ref": "#/components/schemas/Link" }, "title": "Endpoints", "type": "array" }, "hub_slug": { "title": "Hub Slug", "type": "string" }, "manifest_version": { "default": "0.1.0", "title": "Manifest Version", "type": "string" } }, "required": [ "hub_slug" ], "title": "HubCapabilityManifest", "type": "object" }, "HubResource": { "properties": { "capabilities": { "items": { "type": "string" }, "title": "Capabilities", "type": "array" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Description" }, "links": { "items": { "$ref": "#/components/schemas/Link" }, "title": "Links", "type": "array" }, "name": { "title": "Name", "type": "string" }, "slug": { "title": "Slug", "type": "string" }, "status": { "default": "active", "title": "Status", "type": "string" } }, "required": [ "slug", "name" ], "title": "HubResource", "type": "object" }, "Link": { "properties": { "href": { "title": "Href", "type": "string" }, "rel": { "title": "Rel", "type": "string" } }, "required": [ "rel", "href" ], "title": "Link", "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": "get_annotations", "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 Get Annotations", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Annotations Endpoint", "tags": [ "api-v2", "api-v2-protected" ] }, "post": { "operationId": "post_annotations", "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 Post Annotations", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Post Annotations Endpoint", "tags": [ "api-v2", "api-v2-protected" ] } }, "/api/v2/api-consumers": { "get": { "operationId": "get_api_consumers", "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 Get Api Consumers", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Api Consumers Endpoint", "tags": [ "api-v2", "api-v2-protected" ] }, "post": { "operationId": "post_api_consumers", "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 Post Api Consumers", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Post Api Consumers Endpoint", "tags": [ "api-v2", "api-v2-protected" ] } }, "/api/v2/decision-records": { "get": { "operationId": "get_decision_records", "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 Get Decision Records", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Decision Records Endpoint", "tags": [ "api-v2", "api-v2-protected" ] }, "post": { "operationId": "post_decision_records", "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 Post Decision Records", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Post Decision Records Endpoint", "tags": [ "api-v2", "api-v2-protected" ] } }, "/api/v2/deployment-records": { "get": { "operationId": "get_deployment_records", "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 Get Deployment Records", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Deployment Records Endpoint", "tags": [ "api-v2", "api-v2-protected" ] }, "post": { "operationId": "post_deployment_records", "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 Post Deployment Records", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Post Deployment Records Endpoint", "tags": [ "api-v2", "api-v2-protected" ] } }, "/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", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/HubCapabilityManifest" }, "title": "Response List Hub Capability Manifests Api V2 Hub Capability Manifests Get", "type": "array" } } }, "description": "Successful Response" } }, "summary": "List Hub Capability Manifests", "tags": [ "api-v2" ] } }, "/api/v2/hub-registry": { "get": { "operationId": "get_hub_registry", "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 Get Hub Registry", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Hub Registry Endpoint", "tags": [ "api-v2", "api-v2-protected" ] } }, "/api/v2/hubs": { "get": { "operationId": "list_hubs_api_v2_hubs_get", "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/HubResource" }, "title": "Response List Hubs Api V2 Hubs Get", "type": "array" } } }, "description": "Successful Response" } }, "summary": "List Hubs", "tags": [ "api-v2" ] } }, "/api/v2/interaction-events": { "get": { "operationId": "get_interaction_events", "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 Get Interaction Events", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Interaction Events Endpoint", "tags": [ "api-v2", "api-v2-protected" ] }, "post": { "operationId": "post_interaction_events", "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 Post Interaction Events", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Post Interaction Events Endpoint", "tags": [ "api-v2", "api-v2-protected" ] } }, "/api/v2/outcome-signals": { "get": { "operationId": "get_outcome_signals", "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 Get Outcome Signals", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Outcome Signals Endpoint", "tags": [ "api-v2", "api-v2-protected" ] }, "post": { "operationId": "post_outcome_signals", "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 Post Outcome Signals", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Post Outcome Signals Endpoint", "tags": [ "api-v2", "api-v2-protected" ] } }, "/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": "get_requirement_candidates", "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 Get Requirement Candidates", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Requirement Candidates Endpoint", "tags": [ "api-v2", "api-v2-protected" ] }, "post": { "operationId": "post_requirement_candidates", "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 Post Requirement Candidates", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Post Requirement Candidates Endpoint", "tags": [ "api-v2", "api-v2-protected" ] } }, "/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": "get_widgets", "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 Get Widgets", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Get Widgets Endpoint", "tags": [ "api-v2", "api-v2-protected" ] }, "post": { "operationId": "post_widgets", "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 Post Widgets", "type": "object" } } }, "description": "Successful Response" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HTTPValidationError" } } }, "description": "Validation Error" } }, "summary": "Post Widgets Endpoint", "tags": [ "api-v2", "api-v2-protected" ] } }, "/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" ] } } } }