{ "openapi": "3.1.1", "info": { "title": "Componecat REST API", "description": "REST API for managing resources via personal access tokens.", "version": "v1" }, "servers": [ { "url": "https://app.componecat.ai/" } ], "paths": { "/api/rest/v1/audit-log": { "get": { "tags": [ "Audit Log" ], "summary": "List audit log entries for the current organization", "operationId": "ListAuditLog", "parameters": [ { "name": "skip", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "take", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/rest/v1/organizations": { "get": { "tags": [ "Organizations" ], "summary": "List organizations", "operationId": "ListOrganizations", "parameters": [ { "name": "first", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "after", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Organizations" ], "summary": "Create an organization", "operationId": "CreateOrganization", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResource" } } } } } } }, "/api/rest/v1/organizations/{id}": { "get": { "tags": [ "Organizations" ], "summary": "Get an organization by id", "operationId": "GetOrganization", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResource" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "Organizations" ], "summary": "Update an organization", "operationId": "UpdateOrganization", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResource" } } } } } }, "delete": { "tags": [ "Organizations" ], "summary": "Delete an organization", "operationId": "DeleteOrganization", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/organizations/current": { "get": { "tags": [ "Organizations" ], "summary": "Get the current organization", "operationId": "GetCurrentOrganization", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResource" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "Organizations" ], "summary": "Update the current organization", "operationId": "UpdateCurrentOrganization", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationResource" } } } } } }, "delete": { "tags": [ "Organizations" ], "summary": "Delete the current organization", "operationId": "DeleteCurrentOrganization", "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/organization-users": { "get": { "tags": [ "Organization Users" ], "summary": "List members of the current organization", "operationId": "ListOrganizationUsers", "parameters": [ { "name": "first", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "after", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Organization Users" ], "summary": "Add an existing user to the current organization", "operationId": "AddOrganizationUser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddOrganizationUserRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationUserResource" } } } } } } }, "/api/rest/v1/users": { "post": { "tags": [ "Organization Users" ], "summary": "Provision a new user in the current organization", "operationId": "CreateUser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationUserResource" } } } } } } }, "/api/rest/v1/pending-organization-users": { "post": { "tags": [ "Organization Users" ], "summary": "Invite a user to the current organization by email", "operationId": "AddPendingOrganizationUser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddPendingOrganizationUserRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationUserResource" } } } } } } }, "/api/rest/v1/pending-organization-users/{email}": { "delete": { "tags": [ "Organization Users" ], "summary": "Revoke a pending invitation by email", "operationId": "RemovePendingOrganizationUser", "parameters": [ { "name": "email", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/organization-users/{userId}/role": { "patch": { "tags": [ "Organization Users" ], "summary": "Change a member's role", "operationId": "UpdateOrganizationUserRole", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateOrganizationUserRoleRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrganizationUserResource" } } } } } } }, "/api/rest/v1/organization-users/{userId}": { "delete": { "tags": [ "Organization Users" ], "summary": "Remove a member from the current organization", "operationId": "RemoveOrganizationUser", "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/outgoing-webhooks": { "get": { "tags": [ "Outgoing Webhooks" ], "summary": "List outgoing webhooks in the current organization", "operationId": "ListOutgoingWebhooks", "parameters": [ { "name": "skip", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "take", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Outgoing Webhooks" ], "summary": "Create an outgoing webhook (returns the signing secret once)", "operationId": "CreateOutgoingWebhook", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOutgoingWebhookRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedOutgoingWebhookResource" } } } } } } }, "/api/rest/v1/outgoing-webhooks/{id}": { "patch": { "tags": [ "Outgoing Webhooks" ], "summary": "Update an outgoing webhook", "operationId": "UpdateOutgoingWebhook", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OutgoingWebhookResource" } } } } } }, "delete": { "tags": [ "Outgoing Webhooks" ], "summary": "Delete an outgoing webhook", "operationId": "DeleteOutgoingWebhook", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/outgoing-webhooks/{id}/rotate-secret": { "post": { "tags": [ "Outgoing Webhooks" ], "summary": "Rotate an outgoing webhook's signing secret", "operationId": "RotateOutgoingWebhookSecret", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RotatedSecretResource" } } } } } } }, "/api/rest/v1/ai-models": { "get": { "tags": [ "AI Models" ], "summary": "List AI models available to the current organization", "operationId": "ListAIModels", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AIModelEntryResource" } } } } } } }, "post": { "tags": [ "AI Models" ], "summary": "Create an AI model configuration", "operationId": "CreateAIModel", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAIModelRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIModelResource" } } } } } } }, "/api/rest/v1/ai-models/{id}": { "patch": { "tags": [ "AI Models" ], "summary": "Update an AI model configuration", "operationId": "UpdateAIModel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateAIModelRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIModelResource" } } } } } }, "delete": { "tags": [ "AI Models" ], "summary": "Delete an AI model configuration", "operationId": "DeleteAIModel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/ai-models/{id}/set-default": { "post": { "tags": [ "AI Models" ], "summary": "Set an AI model as the organization default", "operationId": "SetDefaultAIModel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AIModelResource" } } } } } } }, "/api/rest/v1/ai-models/test-connection": { "post": { "tags": [ "AI Models" ], "summary": "Test connectivity to an AI model provider", "operationId": "TestAIModelConnection", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestAIModelConnectionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TestAIModelConnectionResult" } } } } } } }, "/api/rest/v1/license": { "get": { "tags": [ "Licensing" ], "summary": "Get the current organization's license", "operationId": "GetLicense", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LicenseResource" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/license/overages": { "get": { "tags": [ "Licensing" ], "summary": "List the current organization's entitlement overages", "operationId": "GetLicenseOverages", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OverageResource" } } } } } } } }, "/api/rest/v1/license/history": { "get": { "tags": [ "Licensing" ], "summary": "List the current organization's license history", "operationId": "GetLicenseHistory", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseHistoryResource" } } } } } } } }, "/api/rest/v1/service-accounts": { "get": { "tags": [ "Service Accounts" ], "summary": "List service accounts in the current organization", "operationId": "ListServiceAccounts", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceAccountResource" } } } } } } }, "post": { "tags": [ "Service Accounts" ], "summary": "Provision a new service account", "operationId": "CreateServiceAccount", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateServiceAccountRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedServiceAccountResource" } } } } } } }, "/api/rest/v1/service-accounts/{id}": { "put": { "tags": [ "Service Accounts" ], "summary": "Rename a service account or change its role", "operationId": "UpdateServiceAccount", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateServiceAccountRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdatedServiceAccountResource" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Service Accounts" ], "summary": "Delete a service account and its credentials", "operationId": "DeleteServiceAccount", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/service-accounts/{serviceAccountId}/credentials": { "get": { "tags": [ "Credentials" ], "summary": "List a service account's credentials (OAuth clients, federated trusts, and access tokens)", "operationId": "ListServiceAccountCredentials", "parameters": [ { "name": "serviceAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialResource" } } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/service-accounts/{serviceAccountId}/credentials/{id}": { "get": { "tags": [ "Credentials" ], "summary": "Get one of a service account's credentials", "operationId": "GetServiceAccountCredential", "parameters": [ { "name": "serviceAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CredentialResource" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Credentials" ], "summary": "Permanently delete a service account's credential", "operationId": "DeleteServiceAccountCredential", "parameters": [ { "name": "serviceAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/service-accounts/{serviceAccountId}/credentials/oauth-clients": { "post": { "tags": [ "Credentials" ], "summary": "Issue an OAuth client to a service account (returns the client secret once)", "operationId": "CreateOAuthClient", "parameters": [ { "name": "serviceAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOAuthClientRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedOAuthClientResource" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/service-accounts/{serviceAccountId}/credentials/federated-trusts": { "post": { "tags": [ "Credentials" ], "summary": "Register a federated identity trust for a service account", "operationId": "CreateServiceAccountFederation", "parameters": [ { "name": "serviceAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFederationRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedFederationResource" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/service-accounts/{serviceAccountId}/credentials/tokens": { "post": { "tags": [ "Credentials" ], "summary": "Mint an access token for a service account (returns the token once)", "operationId": "CreateServiceAccountToken", "parameters": [ { "name": "serviceAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateServiceAccountTokenRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatedServiceAccountTokenResource" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/service-accounts/{serviceAccountId}/credentials/{id}/revoke": { "post": { "tags": [ "Credentials" ], "summary": "Revoke a service account's credential", "operationId": "RevokeServiceAccountCredential", "parameters": [ { "name": "serviceAccountId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokedCredentialResource" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/global-search": { "get": { "tags": [ "Global Search" ], "summary": "Search every registered provider and return one merged, ranked result list", "operationId": "GlobalSearch", "parameters": [ { "name": "q", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "kinds", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GlobalSearchResponseResource" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/HttpValidationProblemDetails" } } } } } } }, "/api/rest/v1/catalog": { "get": { "tags": [ "Catalog" ], "summary": "List all catalog entities", "operationId": "ListCatalogEntities", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiListResponseOfCatalogEntityListItem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Catalog" ], "summary": "Create a new catalog entity", "operationId": "CreateCatalogEntity", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCatalogEntityRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogEntityDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/search": { "get": { "tags": [ "Catalog" ], "summary": "Search catalog entities with filtering, field filters, sorting, facets, and relevance ranking", "operationId": "SearchCatalogEntities", "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "offset", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "kindId", "in": "query", "schema": { "type": "string" } }, { "name": "lifecycle", "in": "query", "schema": { "type": "string" } }, { "name": "ownerId", "in": "query", "schema": { "type": "string" } }, { "name": "tag", "in": "query", "schema": { "type": "string" } }, { "name": "language", "in": "query", "schema": { "type": "string" } }, { "name": "namespace", "in": "query", "schema": { "type": "string" } }, { "name": "sortByField", "in": "query", "schema": { "type": "string" } }, { "name": "sortDescending", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogSearchRestResult" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/{id}": { "get": { "tags": [ "Catalog" ], "summary": "Get a catalog entity by ID", "operationId": "GetCatalogEntity", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogEntityDetail" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "Catalog" ], "summary": "Partially update a catalog entity", "operationId": "UpdateCatalogEntity", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" }, "example": { "description": "Updated description", "fieldValues": { "costCenter": "CC-100", "tier": 1, "isPublic": true, "environments": [ "prod", "staging" ] } } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogEntityDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Catalog" ], "summary": "Delete a catalog entity", "operationId": "DeleteCatalogEntity", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/by-ref": { "get": { "tags": [ "Catalog" ], "summary": "Get a catalog entity by ref (e.g. ?ref=component://namespace/name)", "operationId": "GetCatalogEntityByRef", "parameters": [ { "name": "ref", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogEntityDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/{id}/descriptor": { "get": { "tags": [ "Catalog" ], "summary": "Get the full descriptor document (spec + status) for a catalog entity", "operationId": "GetCatalogEntityDescriptor", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfDescriptorDocument" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/teams": { "get": { "tags": [ "Teams" ], "summary": "List all teams", "operationId": "ListTeams", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiListResponseOfTeamListItem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Teams" ], "summary": "Create a new team", "operationId": "CreateTeam", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTeamRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfTeamDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/teams/{id}": { "get": { "tags": [ "Teams" ], "summary": "Get a team by ID", "operationId": "GetTeam", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfTeamDetail" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "Teams" ], "summary": "Partially update a team", "operationId": "UpdateTeam", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfTeamDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Teams" ], "summary": "Delete a team", "operationId": "DeleteTeam", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/teams/{id}/members": { "get": { "tags": [ "Teams" ], "summary": "List members of a team", "operationId": "ListTeamMembers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfTeamMemberItem[]" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Teams" ], "summary": "Add one or more members to a team", "operationId": "AddTeamMembers", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddTeamMembersRequest" } } }, "required": true }, "responses": { "204": { "description": "No Content" }, "207": { "description": "Multi-Status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddTeamMembersResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/teams/{id}/members/{memberId}": { "delete": { "tags": [ "Teams" ], "summary": "Remove a member from a team", "operationId": "RemoveTeamMember", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "memberId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/entity-field-definitions": { "get": { "tags": [ "Entity Field Definitions" ], "summary": "List all entity field definitions", "operationId": "ListEntityFieldDefinitions", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiListResponseOfEntityFieldDefinitionListItem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Entity Field Definitions" ], "summary": "Create a new entity field definition", "operationId": "CreateEntityFieldDefinition", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEntityFieldDefinitionRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfEntityFieldDefinitionDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/entity-field-definitions/{id}": { "get": { "tags": [ "Entity Field Definitions" ], "summary": "Get an entity field definition by ID", "operationId": "GetEntityFieldDefinition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfEntityFieldDefinitionDetail" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "Entity Field Definitions" ], "summary": "Partially update an entity field definition", "operationId": "UpdateEntityFieldDefinition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfEntityFieldDefinitionDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Entity Field Definitions" ], "summary": "Delete an entity field definition", "operationId": "DeleteEntityFieldDefinition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/entity-kind-definitions": { "get": { "tags": [ "Entity Kind Definitions" ], "summary": "List all entity kind definitions", "operationId": "ListEntityKindDefinitions", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiListResponseOfEntityKindDefinitionListItem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Entity Kind Definitions" ], "summary": "Create a new entity kind definition", "operationId": "CreateEntityKindDefinition", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEntityKindDefinitionRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfEntityKindDefinitionDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/entity-kind-definitions/{id}": { "get": { "tags": [ "Entity Kind Definitions" ], "summary": "Get an entity kind definition by ID", "operationId": "GetEntityKindDefinition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfEntityKindDefinitionDetail" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "put": { "tags": [ "Entity Kind Definitions" ], "summary": "Update an entity kind definition", "operationId": "UpdateEntityKindDefinition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfEntityKindDefinitionDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Entity Kind Definitions" ], "summary": "Delete an entity kind definition", "operationId": "DeleteEntityKindDefinition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/{catalogEntityId}/interfaces": { "get": { "tags": [ "Interfaces" ], "summary": "List interfaces for a catalog entity", "operationId": "ListInterfaces", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfListOfCatalogInterfaceListItem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Interfaces" ], "summary": "Create a new interface", "operationId": "CreateInterface", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCatalogInterfaceRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogInterfaceDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/{catalogEntityId}/interfaces/{id}": { "get": { "tags": [ "Interfaces" ], "summary": "Get an interface by ID", "operationId": "GetInterface", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogInterfaceDetail" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "Interfaces" ], "summary": "Partially update an interface", "operationId": "UpdateInterface", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogInterfaceDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Interfaces" ], "summary": "Delete an interface", "operationId": "DeleteInterface", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/{catalogEntityId}/interfaces/{interfaceId}/spec": { "get": { "tags": [ "Interface Specs" ], "summary": "Get the imported spec for an interface", "operationId": "GetInterfaceSpec", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "interfaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfInterfaceSpecDetail" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/{catalogEntityId}/interfaces/{interfaceId}/spec/import": { "post": { "tags": [ "Interface Specs" ], "summary": "Import or re-import the spec for an interface", "operationId": "ImportInterfaceSpec", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "interfaceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfInterfaceSpecDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/{catalogEntityId}/docs/sections": { "get": { "tags": [ "Documentation Sections" ], "summary": "List documentation sections for a catalog entity", "operationId": "ListCatalogDocumentationSections", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiListResponseOfCatalogDocumentationSectionListItem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Documentation Sections" ], "summary": "Create a new documentation section", "operationId": "CreateCatalogDocumentationSection", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCatalogDocumentationSectionRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogDocumentationSectionDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/{catalogEntityId}/docs/sections/{id}": { "get": { "tags": [ "Documentation Sections" ], "summary": "Get a documentation section by ID", "operationId": "GetCatalogDocumentationSection", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogDocumentationSectionDetail" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "Documentation Sections" ], "summary": "Partially update a documentation section", "operationId": "UpdateCatalogDocumentationSection", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogDocumentationSectionDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Documentation Sections" ], "summary": "Delete a documentation section", "operationId": "DeleteCatalogDocumentationSection", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/{catalogEntityId}/docs/links": { "get": { "tags": [ "Documentation Links" ], "summary": "List documentation links for a catalog entity", "operationId": "ListCatalogDocumentationLinks", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfListOfCatalogDocumentationLinkListItem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Documentation Links" ], "summary": "Create a new documentation link", "operationId": "CreateCatalogDocumentationLink", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCatalogDocumentationLinkRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogDocumentationLinkDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/{catalogEntityId}/docs/links/{id}": { "get": { "tags": [ "Documentation Links" ], "summary": "Get a documentation link by ID", "operationId": "GetCatalogDocumentationLink", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogDocumentationLinkDetail" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "Documentation Links" ], "summary": "Partially update a documentation link", "operationId": "UpdateCatalogDocumentationLink", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogDocumentationLinkDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Documentation Links" ], "summary": "Delete a documentation link", "operationId": "DeleteCatalogDocumentationLink", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/{catalogEntityId}/activity": { "get": { "tags": [ "Activity Log" ], "summary": "List activity log entries for a catalog entity", "operationId": "ListCatalogActivityLogEntries", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiListResponseOfCatalogActivityLogEntryDetail" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Activity Log" ], "summary": "Append a new activity log entry", "operationId": "CreateCatalogActivityLogEntry", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCatalogActivityLogEntryRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogActivityLogEntryDetail" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/{catalogEntityId}/activity/{id}": { "delete": { "tags": [ "Activity Log" ], "summary": "Delete an activity log entry", "operationId": "DeleteCatalogActivityLogEntry", "parameters": [ { "name": "catalogEntityId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/{id}/relationships": { "get": { "tags": [ "Relationships" ], "summary": "List relationships for a catalog entity", "operationId": "ListRelationships", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "kindKey", "in": "query", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogRelationshipItem[]" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Relationships" ], "summary": "Create a new relationship from a catalog entity", "operationId": "CreateRelationship", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRelationshipRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogRelationshipItem" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/{id}/relationships/count": { "get": { "tags": [ "Relationships" ], "summary": "Get relationship count for a catalog entity", "operationId": "GetRelationshipCount", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "kindKey", "in": "query", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfRelationshipCountResult" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/{id}/relationships/{relationshipId}": { "patch": { "tags": [ "Relationships" ], "summary": "Update an existing relationship", "operationId": "UpdateRelationship", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "relationshipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateRelationshipRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogRelationshipItem" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Relationships" ], "summary": "Delete a relationship", "operationId": "DeleteRelationship", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "relationshipId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/{id}/relationships/bulk": { "post": { "tags": [ "Relationships" ], "summary": "Bulk upsert relationships for a catalog entity", "operationId": "BulkUpsertRelationships", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkUpsertRelationshipsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfCatalogRelationshipItem[]" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/catalog/{id}/relationships/transitive": { "get": { "tags": [ "Relationships" ], "summary": "Traverse transitive relationships for a catalog entity", "operationId": "GetTransitiveRelationships", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "kindKey", "in": "query", "schema": { "type": "string" } }, { "name": "direction", "in": "query", "schema": { "type": "string" } }, { "name": "maxDepth", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "maxResults", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfTransitiveRelationshipItem[]" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/relationship-kinds/templates": { "get": { "tags": [ "Relationship Kind Definitions" ], "summary": "List available relationship kind templates", "operationId": "ListRelationshipKindTemplates", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiListResponseOfRelationshipKindTemplateItem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/relationship-kinds": { "get": { "tags": [ "Relationship Kind Definitions" ], "summary": "List all relationship kind definitions", "description": "Supports cursor-based pagination via `limit` and `cursor` query parameters.", "operationId": "ListRelationshipKindDefinitions", "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiListResponseOfRelationshipKindDefinitionItem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Relationship Kind Definitions" ], "summary": "Create a new relationship kind definition", "operationId": "CreateRelationshipKindDefinition", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateRelationshipKindDefinitionRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfRelationshipKindDefinitionItem" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/relationship-kinds/{id}": { "get": { "tags": [ "Relationship Kind Definitions" ], "summary": "Get a relationship kind definition by ID", "operationId": "GetRelationshipKindDefinition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfRelationshipKindDefinitionItem" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "patch": { "tags": [ "Relationship Kind Definitions" ], "summary": "Update a relationship kind definition", "operationId": "UpdateRelationshipKindDefinition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JsonElement" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfRelationshipKindDefinitionItem" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "delete": { "tags": [ "Relationship Kind Definitions" ], "summary": "Delete a relationship kind definition", "operationId": "DeleteRelationshipKindDefinition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/kind-relationship-assignments": { "get": { "tags": [ "Kind Relationship Assignments" ], "summary": "List relationship assignments for an entity kind", "operationId": "ListKindRelationshipAssignments", "parameters": [ { "name": "kindId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiListResponseOfKindRelationshipAssignmentItem" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } }, "post": { "tags": [ "Kind Relationship Assignments" ], "summary": "Assign a relationship kind to an entity kind", "operationId": "CreateKindRelationshipAssignment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateKindRelationshipAssignmentRequest" } } }, "required": true }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RestApiResponseOfKindRelationshipAssignmentItem" } } } }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } }, "/api/rest/v1/kind-relationship-assignments/{kindId}/{relationshipKindId}": { "delete": { "tags": [ "Kind Relationship Assignments" ], "summary": "Remove a relationship kind assignment from an entity kind", "operationId": "DeleteKindRelationshipAssignment", "parameters": [ { "name": "kindId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "relationshipKindId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "401": { "description": "Unauthorized", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "403": { "description": "Forbidden", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "404": { "description": "Not Found", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "409": { "description": "Conflict", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } }, "429": { "description": "Too Many Requests", "content": { "application/problem+json": { "schema": { "$ref": "#/components/schemas/ProblemDetails" } } } } } } } }, "components": { "schemas": { "AddOrganizationUserRequest": { "required": [ "userId", "role" ], "type": "object", "properties": { "userId": { "type": "string", "format": "uuid" }, "role": { "type": "string" } }, "description": "Request body for adding an existing user to the current organization." }, "AddPendingOrganizationUserRequest": { "required": [ "email", "role" ], "type": "object", "properties": { "email": { "type": "string" }, "role": { "type": "string" } }, "description": "Request body for inviting a user to the current organization by email." }, "AddTeamMemberResult": { "required": [ "memberId", "status" ], "type": "object", "properties": { "memberId": { "type": "string", "format": "uuid" }, "status": { "type": "string" }, "errorCode": { "type": [ "null", "string" ] }, "error": { "type": [ "null", "string" ] } } }, "AddTeamMembersRequest": { "required": [ "memberIds" ], "type": "object", "properties": { "memberIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } } }, "AddTeamMembersResponse": { "required": [ "results" ], "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/AddTeamMemberResult" } } } }, "AIModelEntryResource": { "required": [ "id", "name", "provider", "modelId", "properties", "isDefault", "enabled", "source", "usedAt", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "provider": { "type": "string" }, "modelId": { "type": "string" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/AIModelPropertyResource" } }, "isDefault": { "type": "boolean" }, "enabled": { "type": "boolean" }, "source": { "type": "string" }, "usedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": [ "null", "string" ], "format": "date-time" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "AIModelPropertyRequest": { "required": [ "key", "value" ], "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "AIModelPropertyResource": { "required": [ "key", "value" ], "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "AIModelResource": { "required": [ "id", "name", "provider", "modelId", "properties", "isDefault", "enabled", "usedAt", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "provider": { "type": "string" }, "modelId": { "type": "string" }, "properties": { "type": "array", "items": { "$ref": "#/components/schemas/AIModelPropertyResource" } }, "isDefault": { "type": "boolean" }, "enabled": { "type": "boolean" }, "usedAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "BulkRelationshipItemRequest": { "required": [ "targetEntityId" ], "type": "object", "properties": { "targetEntityId": { "type": "string", "format": "uuid" }, "description": { "type": [ "null", "string" ] } } }, "BulkUpsertRelationshipsRequest": { "required": [ "relationshipKindKey", "relationships" ], "type": "object", "properties": { "relationshipKindKey": { "type": "string" }, "relationships": { "type": "array", "items": { "$ref": "#/components/schemas/BulkRelationshipItemRequest" } } } }, "CatalogActivityLogEntryDetail": { "required": [ "id", "catalogEntityId", "content", "createdById", "expiresAt", "organizationId", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "catalogEntityId": { "type": "string", "format": "uuid" }, "content": { "type": "string" }, "createdById": { "type": [ "null", "string" ], "format": "uuid" }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "CatalogDocumentationLinkDetail": { "required": [ "id", "catalogEntityId", "title", "url", "linkType", "sortOrder", "organizationId", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "catalogEntityId": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "url": { "type": "string" }, "linkType": { "type": "string" }, "sortOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "CatalogDocumentationLinkListItem": { "required": [ "id", "catalogEntityId", "title", "url", "linkType", "sortOrder" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "catalogEntityId": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "url": { "type": "string" }, "linkType": { "type": "string" }, "sortOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "CatalogDocumentationSectionDetail": { "required": [ "id", "catalogEntityId", "sectionType", "customSectionType", "title", "content", "sortOrder", "organizationId", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "catalogEntityId": { "type": "string", "format": "uuid" }, "sectionType": { "type": "string" }, "customSectionType": { "type": [ "null", "string" ] }, "title": { "type": "string" }, "content": { "type": [ "null", "string" ] }, "sortOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "CatalogDocumentationSectionListItem": { "required": [ "id", "catalogEntityId", "sectionType", "customSectionType", "title", "sortOrder" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "catalogEntityId": { "type": "string", "format": "uuid" }, "sectionType": { "type": "string" }, "customSectionType": { "type": [ "null", "string" ] }, "title": { "type": "string" }, "sortOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "CatalogEntityDetail": { "required": [ "id", "name", "namespace", "displayName", "kindId", "ownerId", "lifecycle", "description", "tags", "repository", "languages", "fields", "organizationId", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "namespace": { "type": [ "null", "string" ] }, "displayName": { "type": "string" }, "kindId": { "type": "string" }, "ownerId": { "type": "string", "format": "uuid" }, "lifecycle": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "repository": { "type": [ "null", "string" ] }, "languages": { "type": [ "null", "array" ], "items": { "type": "string" } }, "fields": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/JsonElement" } ] }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "CatalogEntityListItem": { "required": [ "id", "name", "namespace", "displayName", "kindId", "ownerId", "lifecycle", "description" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "namespace": { "type": [ "null", "string" ] }, "displayName": { "type": "string" }, "kindId": { "type": "string" }, "ownerId": { "type": "string", "format": "uuid" }, "lifecycle": { "type": "string" }, "description": { "type": "string" }, "languages": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "CatalogInterfaceDetail": { "required": [ "id", "catalogEntityId", "name", "kind", "protocol", "url", "healthCheckUrl", "authMethod", "specUrl", "labels", "visibility", "rateLimit", "organizationId", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "catalogEntityId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "kind": { "type": "string" }, "protocol": { "type": [ "null", "string" ] }, "url": { "type": [ "null", "string" ] }, "healthCheckUrl": { "type": [ "null", "string" ] }, "authMethod": { "type": [ "null", "string" ] }, "specUrl": { "type": [ "null", "string" ] }, "labels": { "type": "array", "items": { "type": "string" } }, "visibility": { "type": "string" }, "rateLimit": { "type": [ "null", "string" ] }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "executableName": { "type": [ "null", "string" ] }, "installMethod": { "type": [ "null", "string" ] }, "installCommand": { "type": [ "null", "string" ] }, "version": { "type": [ "null", "string" ] }, "documentationUrl": { "type": [ "null", "string" ] }, "sourceUrl": { "type": [ "null", "string" ] }, "transportType": { "type": [ "null", "string" ] }, "command": { "type": [ "null", "string" ] }, "toolCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "resourceCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "sharePlatform": { "type": [ "null", "string" ] }, "shareName": { "type": [ "null", "string" ] }, "shareScope": { "type": [ "null", "string" ] }, "listingUrl": { "type": [ "null", "string" ] }, "registryType": { "type": [ "null", "string" ] }, "packageName": { "type": [ "null", "string" ] }, "registryUrl": { "type": [ "null", "string" ] } } }, "CatalogInterfaceListItem": { "required": [ "id", "catalogEntityId", "name", "kind", "protocol", "url", "authMethod", "labels", "visibility" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "catalogEntityId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "kind": { "type": "string" }, "protocol": { "type": [ "null", "string" ] }, "url": { "type": [ "null", "string" ] }, "authMethod": { "type": [ "null", "string" ] }, "labels": { "type": "array", "items": { "type": "string" } }, "visibility": { "type": "string" }, "executableName": { "type": [ "null", "string" ] }, "installMethod": { "type": [ "null", "string" ] }, "transportType": { "type": [ "null", "string" ] }, "toolCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "resourceCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "sharePlatform": { "type": [ "null", "string" ] }, "shareName": { "type": [ "null", "string" ] }, "shareScope": { "type": [ "null", "string" ] }, "listingUrl": { "type": [ "null", "string" ] }, "registryType": { "type": [ "null", "string" ] }, "packageName": { "type": [ "null", "string" ] } } }, "CatalogRelationshipItem": { "required": [ "id", "relationshipKindId", "relationshipKindKey", "sourceEntityId", "targetEntityId", "description", "source", "confidence", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "relationshipKindId": { "type": "string", "format": "uuid" }, "relationshipKindKey": { "type": [ "null", "string" ] }, "sourceEntityId": { "type": "string", "format": "uuid" }, "targetEntityId": { "type": "string", "format": "uuid" }, "description": { "type": [ "null", "string" ] }, "source": { "type": "string" }, "confidence": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "CatalogSearchFacetsDto": { "required": [ "kinds", "lifecycles", "owners", "tags", "fields" ], "type": "object", "properties": { "kinds": { "type": "array", "items": { "$ref": "#/components/schemas/KindFacetDto" } }, "lifecycles": { "type": "array", "items": { "$ref": "#/components/schemas/LifecycleFacetDto" } }, "owners": { "type": "array", "items": { "$ref": "#/components/schemas/OwnerFacetDto" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/TagFacetDto" } }, "fields": { "type": "array", "items": { "$ref": "#/components/schemas/FieldFacetDto" } } } }, "CatalogSearchRestResult": { "required": [ "items", "totalCount", "facets" ], "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogSearchResultItemDto" } }, "totalCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "facets": { "$ref": "#/components/schemas/CatalogSearchFacetsDto" } } }, "CatalogSearchResultItemDto": { "required": [ "id", "name", "namespace", "displayName", "kindId", "ownerId", "lifecycle", "description", "rank" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "namespace": { "type": [ "null", "string" ] }, "displayName": { "type": "string" }, "kindId": { "type": "string" }, "ownerId": { "type": "string", "format": "uuid" }, "lifecycle": { "type": "string" }, "description": { "type": "string" }, "rank": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "docSnippet": { "type": [ "null", "string" ] }, "docSectionTitle": { "type": [ "null", "string" ] } } }, "CreateAIModelRequest": { "required": [ "name", "provider", "modelId", "properties", "secrets", "isDefault", "enabled" ], "type": "object", "properties": { "name": { "type": "string" }, "provider": { "type": "string" }, "modelId": { "type": "string" }, "properties": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AIModelPropertyRequest" } }, "secrets": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AIModelPropertyRequest" } }, "isDefault": { "type": "boolean" }, "enabled": { "type": [ "null", "boolean" ] } } }, "CreateCatalogActivityLogEntryRequest": { "required": [ "content" ], "type": "object", "properties": { "content": { "type": "string" }, "expiresAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "CreateCatalogDocumentationLinkRequest": { "required": [ "title", "url" ], "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string" }, "linkType": { "type": "string", "default": "Other" }, "sortOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } }, "CreateCatalogDocumentationSectionRequest": { "type": "object", "properties": { "sectionType": { "type": "string", "default": "Overview" }, "customSectionType": { "type": [ "null", "string" ] }, "title": { "type": "string", "default": "Overview" }, "content": { "type": [ "null", "string" ] }, "sortOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } }, "CreateCatalogEntityRequest": { "required": [ "displayName", "kindId", "ownerId", "lifecycle", "description" ], "type": "object", "properties": { "displayName": { "type": "string" }, "kindId": { "type": "string", "format": "uuid" }, "ownerId": { "type": "string", "format": "uuid" }, "lifecycle": { "type": "string" }, "description": { "type": "string" }, "name": { "type": [ "null", "string" ] }, "namespace": { "type": [ "null", "string" ] }, "tags": { "type": [ "null", "array" ], "items": { "type": "string" } }, "repository": { "type": [ "null", "string" ] }, "languages": { "type": [ "null", "array" ], "items": { "type": "string" } }, "fieldValues": { "type": [ "null", "object" ], "description": "Kind-specific custom field values, as a JSON object keyed by each field definition's `key` (not an array). Send every value in its native JSON type matching the field's type: string (Text, Date, Url, Select, User, Team), number (Number), boolean (Boolean), array of strings (MultiSelect, Tag), or any JSON value (Json). Keys must resolve to field definitions assigned to the entity's kind; unknown keys are rejected. On PATCH, supplied keys merge into the existing values and a null value removes that field.", "example": { "costCenter": "CC-100", "tier": 1, "isPublic": true, "environments": [ "prod", "staging" ] } } } }, "CreateCatalogInterfaceRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "kind": { "type": "string", "default": "Api" }, "protocol": { "type": [ "null", "string" ] }, "url": { "type": [ "null", "string" ] }, "healthCheckUrl": { "type": [ "null", "string" ] }, "authMethod": { "type": [ "null", "string" ] }, "specUrl": { "type": [ "null", "string" ] }, "labels": { "type": [ "null", "array" ], "items": { "type": "string" } }, "visibility": { "type": "string", "default": "Internal" }, "rateLimit": { "type": [ "null", "string" ] }, "executableName": { "type": [ "null", "string" ] }, "installMethod": { "type": [ "null", "string" ] }, "installCommand": { "type": [ "null", "string" ] }, "version": { "type": [ "null", "string" ] }, "documentationUrl": { "type": [ "null", "string" ] }, "sourceUrl": { "type": [ "null", "string" ] }, "transportType": { "type": [ "null", "string" ] }, "command": { "type": [ "null", "string" ] }, "toolCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "resourceCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "sharePlatform": { "type": [ "null", "string" ] }, "shareName": { "type": [ "null", "string" ] }, "shareScope": { "type": [ "null", "string" ] }, "listingUrl": { "type": [ "null", "string" ] }, "registryType": { "type": [ "null", "string" ] }, "packageName": { "type": [ "null", "string" ] }, "registryUrl": { "type": [ "null", "string" ] } } }, "CreatedFederationResource": { "required": [ "id", "name", "issuer", "subject", "audience", "metadataAddress", "issuerVerifiedAt", "expiresAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "issuer": { "type": "string" }, "subject": { "type": "string" }, "audience": { "type": "string" }, "metadataAddress": { "type": [ "null", "string" ] }, "issuerVerifiedAt": { "type": [ "null", "string" ], "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" } }, "description": "The registered federated identity trust returned by the REST create-federation endpoint, echoing\nthe (issuer, subject, audience) tuple as stored. There is no secret — the workload authenticates\nwith a signed assertion from the trusted issuer." }, "CreatedOAuthClientResource": { "required": [ "id", "clientId", "clientSecret", "name", "expiresAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "name": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" } }, "description": "The issued OAuth client returned by the REST create endpoint; the secret is shown only once.\nThe credential is subsequently addressable at `…/credentials/{id}`." }, "CreatedOutgoingWebhookResource": { "required": [ "id", "url", "description", "status", "secret", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "status": { "type": "string" }, "secret": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } } }, "CreatedServiceAccountResource": { "required": [ "id", "name", "role" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "role": { "type": "string" } }, "description": "The provisioned service account returned by the REST create endpoint." }, "CreatedServiceAccountTokenResource": { "required": [ "id", "name", "expiresAt", "token" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "token": { "type": "string" } }, "description": "The minted service-account access token returned by the REST create-token endpoint;\nstring CreatedServiceAccountTokenResource.Token is shown only once." }, "CreateEntityFieldDefinitionRequest": { "required": [ "key", "displayName" ], "type": "object", "properties": { "key": { "type": "string" }, "displayName": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "fieldType": { "type": "string", "default": "Text" }, "category": { "type": "string", "default": "General" }, "options": { "type": [ "null", "string" ] }, "defaultValue": { "type": [ "null", "string" ] }, "isSearchable": { "type": "boolean", "default": false } } }, "CreateEntityKindDefinitionRequest": { "required": [ "key", "displayName" ], "type": "object", "properties": { "key": { "type": "string" }, "displayName": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "icon": { "type": "string", "default": "box" }, "color": { "type": "string", "default": "sky" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 }, "hasDocumentation": { "type": "boolean", "default": true }, "hasRepository": { "type": "boolean", "default": false }, "hasInterfaces": { "type": "boolean", "default": true }, "hasActivityLog": { "type": "boolean", "default": false }, "allowedInterfaceKinds": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "CreateFederationRequest": { "required": [ "name", "issuer", "subject", "audience", "scopes", "expiresInDays" ], "type": "object", "properties": { "name": { "type": "string" }, "issuer": { "type": "string" }, "subject": { "type": "string" }, "audience": { "type": "string" }, "scopes": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialScopeRequest" } }, "expiresInDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "metadataAddress": { "type": [ "null", "string" ] }, "assertion": { "type": [ "null", "string" ] } }, "description": "Request body for registering a federated identity trust. The service account comes from the route.\nstring? CreateFederationRequest.MetadataAddress is supplied only when the organization is bringing its own issuer and\nits discovery document is not at the issuer's well-known path. string? CreateFederationRequest.Assertion is a fresh,\nissuer-signed proof token the workload mints for exactly this (issuer, subject, audience); it is\nrequired for a self-registered issuer (and for an operator issuer that requires proof of possession)." }, "CreateKindRelationshipAssignmentRequest": { "required": [ "kindId", "relationshipKindId" ], "type": "object", "properties": { "kindId": { "type": "string", "format": "uuid" }, "relationshipKindId": { "type": "string", "format": "uuid" }, "allowAsSource": { "type": "boolean", "default": true }, "allowAsTarget": { "type": "boolean", "default": true }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 } } }, "CreateOAuthClientRequest": { "required": [ "name", "scopes", "expiresInDays" ], "type": "object", "properties": { "name": { "type": "string" }, "scopes": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialScopeRequest" } }, "expiresInDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "description": "Request body for issuing an OAuth client. The owning service account comes from the route." }, "CreateOrganizationRequest": { "required": [ "name", "slug", "isPublic" ], "type": "object", "properties": { "name": { "type": "string" }, "slug": { "type": [ "null", "string" ] }, "isPublic": { "type": [ "null", "boolean" ] } }, "description": "Request body for creating an organization." }, "CreateOutgoingWebhookRequest": { "required": [ "url", "description", "eventFilters", "detailLevel" ], "type": "object", "properties": { "url": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "eventFilters": { "type": [ "null", "array" ], "items": { "type": "string" } }, "detailLevel": { "type": [ "null", "string" ] } } }, "CreateRelationshipKindDefinitionRequest": { "required": [ "key", "displayName", "sourceLabel", "targetLabel" ], "type": "object", "properties": { "key": { "type": "string" }, "displayName": { "type": "string" }, "sourceLabel": { "type": "string" }, "targetLabel": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "icon": { "type": "string", "default": "link" }, "color": { "type": "string", "default": "sky" }, "cardinality": { "type": "string", "default": "MANY_TO_MANY" }, "cyclePolicy": { "type": "string", "default": "WARN" }, "deletePolicy": { "type": "string", "default": "CASCADE" }, "isHierarchical": { "type": "boolean", "default": false }, "isDependency": { "type": "boolean", "default": false }, "isApiProvider": { "type": "boolean", "default": false } } }, "CreateRelationshipRequest": { "type": "object", "properties": { "relationshipKindId": { "type": [ "null", "string" ], "format": "uuid" }, "relationshipKindKey": { "type": [ "null", "string" ] }, "targetEntityId": { "type": [ "null", "string" ], "format": "uuid" }, "description": { "type": [ "null", "string" ] } } }, "CreateServiceAccountRequest": { "required": [ "name", "role" ], "type": "object", "properties": { "name": { "type": "string" }, "role": { "type": "string" } }, "description": "Request body for provisioning a service account." }, "CreateServiceAccountTokenRequest": { "required": [ "name", "scopes", "expiresInDays" ], "type": "object", "properties": { "name": { "type": "string" }, "scopes": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialScopeRequest" } }, "expiresInDays": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "description": "Request body for minting a service-account access token. The owning service account comes from the route." }, "CreateTeamRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "memberIds": { "type": [ "null", "array" ], "items": { "type": "string", "format": "uuid" } } } }, "CreateUserRequest": { "required": [ "email", "firstName", "lastName", "role" ], "type": "object", "properties": { "email": { "type": "string" }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "role": { "type": [ "null", "string" ] } }, "description": "Request body for provisioning a new user in the current organization." }, "CredentialFederationResource": { "required": [ "issuer", "subject", "audience", "metadataAddress", "issuerVerifiedAt" ], "type": "object", "properties": { "issuer": { "type": "string" }, "subject": { "type": "string" }, "audience": { "type": "string" }, "metadataAddress": { "type": [ "null", "string" ] }, "issuerVerifiedAt": { "type": [ "null", "string" ], "format": "date-time" } }, "description": "The registered trust tuple of a federated credential. (string CredentialFederationResource.Issuer,\nstring CredentialFederationResource.Subject, string CredentialFederationResource.Audience) is the trust's identity — how an incoming\nassertion resolves to this credential. string? CredentialFederationResource.MetadataAddress and\nDateTimeOffset? CredentialFederationResource.IssuerVerifiedAt are set only when the organization brought its own issuer." }, "CredentialResource": { "required": [ "id", "serviceAccountId", "name", "kind", "clientId", "federation", "createdAt", "expiresAt", "usedAt", "revokedAt", "scopes" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "serviceAccountId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "kind": { "type": "string" }, "clientId": { "type": [ "null", "string" ] }, "federation": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CredentialFederationResource" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "string", "format": "date-time" }, "usedAt": { "type": [ "null", "string" ], "format": "date-time" }, "revokedAt": { "type": [ "null", "string" ], "format": "date-time" }, "scopes": { "type": "array", "items": { "$ref": "#/components/schemas/CredentialScopeResource" } } }, "description": "A credential issued to a service account, as returned by the REST list and get endpoints.\nstring CredentialResource.Kind is `pat`, `oauth_client`, or `federated`; string? CredentialResource.ClientId\nis set only for an OAuth client and CredentialFederationResource? CredentialResource.Federation only for a federated trust." }, "CredentialScopeRequest": { "required": [ "resource", "access", "canCreate" ], "type": "object", "properties": { "resource": { "type": "string" }, "access": { "type": "string" }, "canCreate": { "type": [ "null", "boolean" ] } }, "description": "A scope grant supplied when issuing a credential. string CredentialScopeRequest.Access is `none`,\n`read`, or `write` (any casing is accepted)." }, "CredentialScopeResource": { "required": [ "resource", "access", "canCreate", "overrides" ], "type": "object", "properties": { "resource": { "type": "string" }, "access": { "type": "string" }, "canCreate": { "type": "boolean" }, "overrides": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceAccessResource" } } }, "description": "One category grant on a credential: the resource category, its access floor (`none`,\n`read`, or `write`), the create capability, and any per-instance overrides.\nstring CredentialScopeResource.Access carries the same vocabulary the create endpoints accept in\nstring CredentialScopeRequest.Access." }, "DescriptorDocLink": { "required": [ "title", "url" ], "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string" } } }, "DescriptorDocs": { "type": "object", "properties": { "sections": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DescriptorDocSection" } }, "links": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DescriptorDocLink" } } } }, "DescriptorDocSection": { "required": [ "title" ], "type": "object", "properties": { "title": { "type": "string" }, "type": { "type": [ "null", "string" ] }, "content": { "type": [ "null", "string" ] }, "sourcePath": { "type": [ "null", "string" ] }, "sourceRepository": { "type": [ "null", "string" ] }, "sourceBranch": { "type": [ "null", "string" ] }, "contentRef": { "type": [ "null", "string" ] } } }, "DescriptorDocument": { "required": [ "apiVersion", "kind", "metadata" ], "type": "object", "properties": { "apiVersion": { "type": "string" }, "kind": { "type": "string" }, "namespace": { "type": [ "null", "string" ] }, "metadata": { "$ref": "#/components/schemas/DescriptorMetadata" }, "spec": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DescriptorSpec" } ] }, "status": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DescriptorStatus" } ] } } }, "DescriptorInterface": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "kind": { "type": [ "null", "string" ] }, "protocol": { "type": [ "null", "string" ] }, "url": { "type": [ "null", "string" ] }, "healthCheckUrl": { "type": [ "null", "string" ] }, "authMethod": { "type": [ "null", "string" ] }, "specUrl": { "type": [ "null", "string" ] }, "rateLimit": { "type": [ "null", "string" ] }, "visibility": { "type": [ "null", "string" ] }, "labels": { "type": [ "null", "array" ], "items": { "type": "string" } }, "executableName": { "type": [ "null", "string" ] }, "installMethod": { "type": [ "null", "string" ] }, "installCommand": { "type": [ "null", "string" ] }, "version": { "type": [ "null", "string" ] }, "documentationUrl": { "type": [ "null", "string" ] }, "sourceUrl": { "type": [ "null", "string" ] }, "transportType": { "type": [ "null", "string" ] }, "command": { "type": [ "null", "string" ] }, "toolCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "resourceCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "sharePlatform": { "type": [ "null", "string" ] }, "shareName": { "type": [ "null", "string" ] }, "shareScope": { "type": [ "null", "string" ] }, "listingUrl": { "type": [ "null", "string" ] }, "registryType": { "type": [ "null", "string" ] }, "packageName": { "type": [ "null", "string" ] }, "registryUrl": { "type": [ "null", "string" ] } } }, "DescriptorMetadata": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "displayName": { "type": [ "null", "string" ] }, "description": { "type": [ "null", "string" ] }, "owner": { "type": [ "null", "string" ] }, "namespace": { "type": [ "null", "string" ] }, "tags": { "type": [ "null", "array" ], "items": { "type": "string" } }, "lifecycle": { "type": [ "null", "string" ] }, "parent": { "type": [ "null", "string" ] } } }, "DescriptorRelationship": { "required": [ "target", "kind" ], "type": "object", "properties": { "target": { "type": "string" }, "kind": { "type": "string" }, "description": { "type": [ "null", "string" ] } } }, "DescriptorRepositoryStatus": { "type": "object", "properties": { "status": { "type": [ "null", "string" ] }, "defaultBranch": { "type": [ "null", "string" ] }, "metadataUpdatedAt": { "type": [ "null", "string" ], "format": "date-time" }, "hasDescriptorFile": { "type": "boolean" }, "syncStatus": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DescriptorSyncInfo" } ] }, "languages": { "type": [ "null", "array" ], "items": { "type": "string" } }, "readme": { "type": [ "null", "string" ] } } }, "DescriptorSpec": { "type": "object", "properties": { "repository": { "type": [ "null", "string" ] }, "interfaces": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DescriptorInterface" } }, "fields": { "type": [ "null", "object" ] }, "docs": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DescriptorDocs" } ] }, "relationships": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/DescriptorRelationship" } } } }, "DescriptorStatus": { "type": "object", "properties": { "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "activityLogRef": { "type": [ "null", "string" ] }, "activityLog": { "type": [ "null", "string" ] }, "repository": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DescriptorRepositoryStatus" } ] } } }, "DescriptorSyncInfo": { "type": "object", "properties": { "status": { "type": [ "null", "string" ] }, "lastCommitSha": { "type": [ "null", "string" ] }, "syncedAt": { "type": [ "null", "string" ], "format": "date-time" }, "source": { "type": [ "null", "string" ] }, "repository": { "type": [ "null", "string" ] }, "descriptorPath": { "type": [ "null", "string" ] }, "error": { "type": [ "null", "string" ] } } }, "EntityFieldDefinitionDetail": { "required": [ "id", "key", "displayName", "description", "fieldType", "category", "options", "defaultValue", "isSearchable", "schemaVersion", "schemaChangedAt", "organizationId", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "key": { "type": "string" }, "displayName": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "fieldType": { "type": "string" }, "category": { "type": "string" }, "options": { "type": [ "null", "string" ] }, "defaultValue": { "type": [ "null", "string" ] }, "isSearchable": { "type": "boolean" }, "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "schemaChangedAt": { "type": [ "null", "string" ], "format": "date-time" }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "EntityFieldDefinitionListItem": { "required": [ "id", "key", "displayName", "fieldType", "category", "isSearchable" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "key": { "type": "string" }, "displayName": { "type": "string" }, "fieldType": { "type": "string" }, "category": { "type": "string" }, "isSearchable": { "type": "boolean" } } }, "EntityKindDefinitionDetail": { "required": [ "id", "key", "displayName", "description", "icon", "color", "displayOrder", "hasDocumentation", "hasRepository", "hasInterfaces", "hasActivityLog", "allowedInterfaceKinds", "schemaVersion", "schemaChangedAt", "organizationId", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "key": { "type": "string" }, "displayName": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "icon": { "type": "string" }, "color": { "type": "string" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "hasDocumentation": { "type": "boolean" }, "hasRepository": { "type": "boolean" }, "hasInterfaces": { "type": "boolean" }, "hasActivityLog": { "type": "boolean" }, "allowedInterfaceKinds": { "type": "array", "items": { "type": "string" } }, "schemaVersion": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "schemaChangedAt": { "type": "string", "format": "date-time" }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "EntityKindDefinitionListItem": { "required": [ "id", "key", "displayName", "icon", "color", "displayOrder", "hasDocumentation", "hasRepository", "hasInterfaces", "hasActivityLog" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "key": { "type": "string" }, "displayName": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "hasDocumentation": { "type": "boolean" }, "hasRepository": { "type": "boolean" }, "hasInterfaces": { "type": "boolean" }, "hasActivityLog": { "type": "boolean" } } }, "FieldFacetDto": { "required": [ "key", "displayName", "values" ], "type": "object", "properties": { "key": { "type": "string" }, "displayName": { "type": "string" }, "values": { "type": "array", "items": { "$ref": "#/components/schemas/FieldValueFacetDto" } } } }, "FieldValueFacetDto": { "required": [ "value", "count" ], "type": "object", "properties": { "value": { "type": "string" }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "GlobalSearchResponseResource": { "required": [ "results", "totalCount" ], "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/GlobalSearchResultResource" } }, "totalCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "GlobalSearchResultDatumResource": { "required": [ "key", "value" ], "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "string" } } }, "GlobalSearchResultResource": { "required": [ "kind", "id", "title", "group", "subtitle", "excerpt", "path", "score", "data" ], "type": "object", "properties": { "kind": { "type": "string" }, "id": { "type": "string" }, "title": { "type": "string" }, "group": { "type": [ "null", "string" ] }, "subtitle": { "type": [ "null", "string" ] }, "excerpt": { "type": [ "null", "string" ] }, "path": { "type": [ "null", "string" ] }, "score": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "double" }, "data": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/GlobalSearchResultDatumResource" } } } }, "HttpValidationProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] }, "errors": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "string" } } } } }, "InterfaceSpecDetail": { "required": [ "id", "interfaceId", "sourceUrl", "format", "rawContent", "importedAt", "importError", "organizationId", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "interfaceId": { "type": "string", "format": "uuid" }, "sourceUrl": { "type": "string" }, "format": { "type": "string" }, "rawContent": { "type": "string" }, "importedAt": { "type": "string", "format": "date-time" }, "importError": { "type": [ "null", "string" ] }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "JsonElement": { }, "KindFacetDto": { "required": [ "kindId", "kindKey", "count" ], "type": "object", "properties": { "kindId": { "type": "string", "format": "uuid" }, "kindKey": { "type": "string" }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "KindRelationshipAssignmentItem": { "required": [ "kindId", "relationshipKindId", "allowAsSource", "allowAsTarget", "displayOrder" ], "type": "object", "properties": { "kindId": { "type": "string", "format": "uuid" }, "relationshipKindId": { "type": "string", "format": "uuid" }, "allowAsSource": { "type": "boolean" }, "allowAsTarget": { "type": "boolean" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "LicenseHistoryResource": { "required": [ "planId", "planName", "effectiveAt", "endedAt", "changeSource" ], "type": "object", "properties": { "planId": { "type": "string" }, "planName": { "type": "string" }, "effectiveAt": { "type": "string", "format": "date-time" }, "endedAt": { "type": [ "null", "string" ], "format": "date-time" }, "changeSource": { "type": "string" } } }, "LicenseResource": { "required": [ "id", "planId", "planName", "effectiveAt", "createdAt", "updatedAt", "overages", "history" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "planId": { "type": "string" }, "planName": { "type": "string" }, "effectiveAt": { "type": "string", "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": [ "null", "string" ], "format": "date-time" }, "overages": { "type": "array", "items": { "$ref": "#/components/schemas/OverageResource" } }, "history": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseHistoryResource" } } } }, "LifecycleFacetDto": { "required": [ "value", "count" ], "type": "object", "properties": { "value": { "type": "string" }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "OrganizationResource": { "required": [ "id", "name", "slug", "isPublic", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "slug": { "type": [ "null", "string" ] }, "isPublic": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "description": "An organization as returned by the REST endpoints." }, "OrganizationUserResource": { "required": [ "id", "email", "firstName", "lastName", "imageUrl", "role", "status", "createdAt", "membershipCreatedAt" ], "type": "object", "properties": { "id": { "type": [ "null", "string" ], "format": "uuid" }, "email": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] }, "imageUrl": { "type": [ "null", "string" ] }, "role": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": [ "null", "string" ], "format": "date-time" }, "membershipCreatedAt": { "type": "string", "format": "date-time" } }, "description": "An organization member as returned by the REST endpoints. A pending invitation has a null\nGuid? OrganizationUserResource.Id and DateTimeOffset? OrganizationUserResource.CreatedAt and a `PENDING`string OrganizationUserResource.Status." }, "OutgoingWebhookResource": { "required": [ "id", "url", "description", "eventFilters", "detailLevel", "status", "consecutiveFailures", "lastDeliveryAt", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "url": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "eventFilters": { "type": [ "null", "array" ], "items": { "type": "string" } }, "detailLevel": { "type": "string" }, "status": { "type": "string" }, "consecutiveFailures": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "lastDeliveryAt": { "type": [ "null", "string" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "OverageResource": { "required": [ "entitlementKey", "currentValue", "allowedValue", "policy", "gracePeriodEndsAt", "label" ], "type": "object", "properties": { "entitlementKey": { "type": "string" }, "currentValue": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "allowedValue": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "policy": { "type": "string" }, "gracePeriodEndsAt": { "type": [ "null", "string" ], "format": "date-time" }, "label": { "type": "string" } } }, "OwnerFacetDto": { "required": [ "ownerId", "ownerName", "count" ], "type": "object", "properties": { "ownerId": { "type": "string", "format": "uuid" }, "ownerName": { "type": "string" }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "PaginationInfo": { "required": [ "cursor", "hasMore" ], "type": "object", "properties": { "cursor": { "type": [ "null", "string" ] }, "hasMore": { "type": "boolean" } }, "description": "Pagination metadata for REST API list responses." }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] }, "status": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" }, "detail": { "type": [ "null", "string" ] }, "instance": { "type": [ "null", "string" ] } } }, "RelationshipCountResult": { "required": [ "count" ], "type": "object", "properties": { "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "RelationshipKindDefinitionItem": { "required": [ "id", "key", "displayName", "description", "icon", "color", "displayOrder", "isHierarchical", "isDependency", "isApiProvider", "cardinality", "cyclePolicy", "deletePolicy", "sourceLabel", "targetLabel" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "key": { "type": "string" }, "displayName": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "icon": { "type": "string" }, "color": { "type": "string" }, "displayOrder": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "isHierarchical": { "type": "boolean" }, "isDependency": { "type": "boolean" }, "isApiProvider": { "type": "boolean" }, "cardinality": { "type": "string" }, "cyclePolicy": { "type": "string" }, "deletePolicy": { "type": "string" }, "sourceLabel": { "type": "string" }, "targetLabel": { "type": "string" } } }, "RelationshipKindTemplateItem": { "required": [ "key", "displayName", "description", "icon", "color", "cardinality", "cyclePolicy", "deletePolicy", "sourceLabel", "targetLabel", "isHierarchical", "isDependency", "isApiProvider" ], "type": "object", "properties": { "key": { "type": "string" }, "displayName": { "type": "string" }, "description": { "type": "string" }, "icon": { "type": "string" }, "color": { "type": "string" }, "cardinality": { "type": "string" }, "cyclePolicy": { "type": "string" }, "deletePolicy": { "type": "string" }, "sourceLabel": { "type": "string" }, "targetLabel": { "type": "string" }, "isHierarchical": { "type": "boolean" }, "isDependency": { "type": "boolean" }, "isApiProvider": { "type": "boolean" } } }, "ResourceAccessResource": { "required": [ "resourceId", "level" ], "type": "object", "properties": { "resourceId": { "type": "string", "format": "uuid" }, "level": { "type": "string" } }, "description": "A per-instance override raising a single resource above its category floor." }, "RestApiListResponseOfCatalogActivityLogEntryDetail": { "required": [ "data", "pagination" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogActivityLogEntryDetail" } }, "pagination": { "$ref": "#/components/schemas/PaginationInfo" } }, "description": "Standard REST API response envelope for a collection of resources." }, "RestApiListResponseOfCatalogDocumentationSectionListItem": { "required": [ "data", "pagination" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogDocumentationSectionListItem" } }, "pagination": { "$ref": "#/components/schemas/PaginationInfo" } }, "description": "Standard REST API response envelope for a collection of resources." }, "RestApiListResponseOfCatalogEntityListItem": { "required": [ "data", "pagination" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CatalogEntityListItem" } }, "pagination": { "$ref": "#/components/schemas/PaginationInfo" } }, "description": "Standard REST API response envelope for a collection of resources." }, "RestApiListResponseOfEntityFieldDefinitionListItem": { "required": [ "data", "pagination" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EntityFieldDefinitionListItem" } }, "pagination": { "$ref": "#/components/schemas/PaginationInfo" } }, "description": "Standard REST API response envelope for a collection of resources." }, "RestApiListResponseOfEntityKindDefinitionListItem": { "required": [ "data", "pagination" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/EntityKindDefinitionListItem" } }, "pagination": { "$ref": "#/components/schemas/PaginationInfo" } }, "description": "Standard REST API response envelope for a collection of resources." }, "RestApiListResponseOfKindRelationshipAssignmentItem": { "required": [ "data", "pagination" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/KindRelationshipAssignmentItem" } }, "pagination": { "$ref": "#/components/schemas/PaginationInfo" } }, "description": "Standard REST API response envelope for a collection of resources." }, "RestApiListResponseOfRelationshipKindDefinitionItem": { "required": [ "data", "pagination" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RelationshipKindDefinitionItem" } }, "pagination": { "$ref": "#/components/schemas/PaginationInfo" } }, "description": "Standard REST API response envelope for a collection of resources." }, "RestApiListResponseOfRelationshipKindTemplateItem": { "required": [ "data", "pagination" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/RelationshipKindTemplateItem" } }, "pagination": { "$ref": "#/components/schemas/PaginationInfo" } }, "description": "Standard REST API response envelope for a collection of resources." }, "RestApiListResponseOfTeamListItem": { "required": [ "data", "pagination" ], "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TeamListItem" } }, "pagination": { "$ref": "#/components/schemas/PaginationInfo" } }, "description": "Standard REST API response envelope for a collection of resources." }, "RestApiResponseOfCatalogActivityLogEntryDetail": { "required": [ "data" ], "type": "object", "properties": { "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CatalogActivityLogEntryDetail" } ] } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfCatalogDocumentationLinkDetail": { "required": [ "data" ], "type": "object", "properties": { "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CatalogDocumentationLinkDetail" } ] } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfCatalogDocumentationSectionDetail": { "required": [ "data" ], "type": "object", "properties": { "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CatalogDocumentationSectionDetail" } ] } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfCatalogEntityDetail": { "required": [ "data" ], "type": "object", "properties": { "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CatalogEntityDetail" } ] } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfCatalogInterfaceDetail": { "required": [ "data" ], "type": "object", "properties": { "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CatalogInterfaceDetail" } ] } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfCatalogRelationshipItem": { "required": [ "data" ], "type": "object", "properties": { "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CatalogRelationshipItem" } ] } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfCatalogRelationshipItem[]": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CatalogRelationshipItem" } } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfCatalogSearchRestResult": { "required": [ "data" ], "type": "object", "properties": { "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/CatalogSearchRestResult" } ] } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfDescriptorDocument": { "required": [ "data" ], "type": "object", "properties": { "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DescriptorDocument" } ] } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfEntityFieldDefinitionDetail": { "required": [ "data" ], "type": "object", "properties": { "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EntityFieldDefinitionDetail" } ] } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfEntityKindDefinitionDetail": { "required": [ "data" ], "type": "object", "properties": { "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/EntityKindDefinitionDetail" } ] } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfInterfaceSpecDetail": { "required": [ "data" ], "type": "object", "properties": { "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/InterfaceSpecDetail" } ] } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfKindRelationshipAssignmentItem": { "required": [ "data" ], "type": "object", "properties": { "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/KindRelationshipAssignmentItem" } ] } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfListOfCatalogDocumentationLinkListItem": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CatalogDocumentationLinkListItem" } } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfListOfCatalogInterfaceListItem": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/CatalogInterfaceListItem" } } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfRelationshipCountResult": { "required": [ "data" ], "type": "object", "properties": { "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RelationshipCountResult" } ] } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfRelationshipKindDefinitionItem": { "required": [ "data" ], "type": "object", "properties": { "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/RelationshipKindDefinitionItem" } ] } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfTeamDetail": { "required": [ "data" ], "type": "object", "properties": { "data": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TeamDetail" } ] } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfTeamMemberItem[]": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TeamMemberItem" } } }, "description": "Standard REST API response envelope for a single resource." }, "RestApiResponseOfTransitiveRelationshipItem[]": { "required": [ "data" ], "type": "object", "properties": { "data": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/TransitiveRelationshipItem" } } }, "description": "Standard REST API response envelope for a single resource." }, "RevokedCredentialResource": { "required": [ "id", "revokedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "revokedAt": { "type": "string", "format": "date-time" } }, "description": "The revoked credential returned by the REST revoke endpoint." }, "RotatedSecretResource": { "required": [ "webhookId", "newSecret", "rotatedAt" ], "type": "object", "properties": { "webhookId": { "type": "string", "format": "uuid" }, "newSecret": { "type": "string" }, "rotatedAt": { "type": "string", "format": "date-time" } } }, "ServiceAccountResource": { "required": [ "id", "name", "role", "createdAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "role": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } }, "description": "A service account as returned by the REST list endpoint." }, "TagFacetDto": { "required": [ "value", "count" ], "type": "object", "properties": { "value": { "type": "string" }, "count": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "TeamDetail": { "required": [ "id", "name", "description", "memberCount", "ownedEntityCount", "organizationId", "createdAt", "updatedAt" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "memberCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "ownedEntityCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "organizationId": { "type": "string", "format": "uuid" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "TeamListItem": { "required": [ "id", "name", "description", "memberCount" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "memberCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "TeamMemberItem": { "required": [ "id", "email", "firstName", "lastName" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "email": { "type": [ "null", "string" ] }, "firstName": { "type": [ "null", "string" ] }, "lastName": { "type": [ "null", "string" ] } } }, "TestAIModelConnectionRequest": { "required": [ "provider", "modelId", "properties", "secrets", "id" ], "type": "object", "properties": { "provider": { "type": "string" }, "modelId": { "type": "string" }, "properties": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AIModelPropertyRequest" } }, "secrets": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AIModelPropertyRequest" } }, "id": { "type": [ "null", "string" ], "format": "uuid" } } }, "TestAIModelConnectionResult": { "required": [ "ok", "errorCategory", "errorMessage" ], "type": "object", "properties": { "ok": { "type": "boolean" }, "errorCategory": { "type": "string" }, "errorMessage": { "type": [ "null", "string" ] } } }, "TransitiveRelationshipItem": { "required": [ "entityId", "entityName", "entityDisplayName", "depth", "relationshipId" ], "type": "object", "properties": { "entityId": { "type": "string", "format": "uuid" }, "entityName": { "type": "string" }, "entityDisplayName": { "type": "string" }, "depth": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "relationshipId": { "type": [ "null", "string" ], "format": "uuid" } } }, "UpdateAIModelRequest": { "required": [ "name", "provider", "modelId", "properties", "secrets", "isDefault", "enabled", "clearedSecretKeys" ], "type": "object", "properties": { "name": { "type": [ "null", "string" ] }, "provider": { "type": [ "null", "string" ] }, "modelId": { "type": [ "null", "string" ] }, "properties": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AIModelPropertyRequest" } }, "secrets": { "type": [ "null", "array" ], "items": { "$ref": "#/components/schemas/AIModelPropertyRequest" } }, "isDefault": { "type": [ "null", "boolean" ] }, "enabled": { "type": [ "null", "boolean" ] }, "clearedSecretKeys": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "UpdatedServiceAccountResource": { "required": [ "id", "name", "role" ], "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "role": { "type": "string" } }, "description": "The updated service account returned by the REST update endpoint." }, "UpdateOrganizationUserRoleRequest": { "required": [ "role" ], "type": "object", "properties": { "role": { "type": "string" } }, "description": "Request body for changing a member's role." }, "UpdateRelationshipRequest": { "type": "object", "properties": { "description": { "type": [ "null", "string" ] } } }, "UpdateServiceAccountRequest": { "required": [ "name", "role" ], "type": "object", "properties": { "name": { "type": "string" }, "role": { "type": "string" } }, "description": "Request body for renaming a service account or changing its role." } }, "securitySchemes": { "bearer": { "type": "http", "description": "Personal access token. Create one in the application settings.", "scheme": "bearer", "bearerFormat": "JWT" } } }, "security": [ { } ], "tags": [ { "name": "Audit Log" }, { "name": "Organizations" }, { "name": "Organization Users" }, { "name": "Outgoing Webhooks" }, { "name": "AI Models" }, { "name": "Licensing" }, { "name": "Service Accounts" }, { "name": "Credentials" }, { "name": "Global Search" }, { "name": "Catalog" }, { "name": "Teams" }, { "name": "Entity Field Definitions" }, { "name": "Entity Kind Definitions" }, { "name": "Interfaces" }, { "name": "Interface Specs" }, { "name": "Documentation Sections" }, { "name": "Documentation Links" }, { "name": "Activity Log" }, { "name": "Relationships" }, { "name": "Relationship Kind Definitions" }, { "name": "Kind Relationship Assignments" } ] }