{ "openapi": "3.1.1", "info": { "title": "OMGQA.Api | v1", "version": "1.0.0" }, "servers": [ { "url": "https://api.omgqa.com/" } ], "paths": { "/api/v1/ingest/{source}": { "post": { "tags": [ "Test Automation" ], "parameters": [ { "name": "source", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectId", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/flaky-tests": { "get": { "tags": [ "Test Automation" ], "parameters": [ { "name": "quarantined", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/flaky-tests/{id}/quarantine": { "post": { "tags": [ "Test Automation" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/flaky-tests/{id}/unquarantine": { "post": { "tags": [ "Test Automation" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/email/deliverability": { "get": { "tags": [ "Email" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/email/suppressions": { "get": { "tags": [ "Email" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Email" ], "parameters": [ { "name": "email", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/email/webhook": { "post": { "tags": [ "Email" ], "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmailDeliverabilityEvent" } } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/findings/{findingId}/github/issue": { "post": { "tags": [ "GitHub" ], "parameters": [ { "name": "findingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateIssueRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/github/webhook/{orgSlug}": { "post": { "tags": [ "GitHub" ], "parameters": [ { "name": "orgSlug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/azuredevops/findings/{findingId}/sync": { "post": { "tags": [ "Integrations" ], "parameters": [ { "name": "findingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/azuredevops/webhook/{orgSlug}": { "post": { "tags": [ "Integrations" ], "parameters": [ { "name": "orgSlug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/jira/findings/{findingId}/sync": { "post": { "tags": [ "Integrations" ], "parameters": [ { "name": "findingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/jira/webhook/{orgSlug}": { "post": { "tags": [ "Integrations" ], "parameters": [ { "name": "orgSlug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/slack/webhook/{orgSlug}": { "post": { "tags": [ "Integrations" ], "parameters": [ { "name": "orgSlug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/gitlab/findings/{findingId}/links": { "post": { "tags": [ "Integrations" ], "parameters": [ { "name": "findingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GitLabLinkRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Integrations" ], "parameters": [ { "name": "findingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/gitlab/webhook/{orgSlug}": { "post": { "tags": [ "Integrations" ], "parameters": [ { "name": "orgSlug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/github/install": { "get": { "tags": [ "Integrations" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/github/status": { "get": { "tags": [ "Integrations" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/github/app/create": { "get": { "tags": [ "Integrations" ], "parameters": [ { "name": "owner", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/github/app/created": { "get": { "tags": [ "Integrations" ], "parameters": [ { "name": "code", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/github/setup": { "get": { "tags": [ "Integrations" ], "parameters": [ { "name": "installation_id", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" } }, { "name": "state", "in": "query", "schema": { "type": "string" } }, { "name": "setup_action", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/github/{id}": { "delete": { "tags": [ "Integrations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/github/findings/{findingId}/issue": { "post": { "tags": [ "Integrations" ], "parameters": [ { "name": "findingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/GitHubIssueRequest" } ] } } } }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/github/app/webhook": { "post": { "tags": [ "Integrations" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/support/accesses": { "get": { "tags": [ "Support" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/support/staff/orgs/{slug}/health": { "get": { "tags": [ "Support Staff" ], "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/status": { "get": { "tags": [ "Status" ], "responses": { "200": { "description": "OK" } } } }, "/mcp/manifest": { "get": { "tags": [ "MCP" ], "responses": { "200": { "description": "OK" } } } }, "/.well-known/mcp": { "get": { "tags": [ "MCP" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/register": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/login": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/login/request-code": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestLoginCodeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/login/verify-code": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginWithCodeRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/redeem-ticket-link": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedeemTicketLinkRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/refresh": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/logout": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefreshRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/verify-email": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VerifyEmailRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/request-password-reset": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestPasswordResetRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/reset-password": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResetPasswordRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/resend-verification": { "post": { "tags": [ "Auth" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/change-password": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/mfa/enroll": { "post": { "tags": [ "Auth" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/mfa/enable": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EnableMfaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/mfa/disable": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisableMfaRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/me": { "get": { "tags": [ "Auth" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/last-org": { "put": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetLastOrganizationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/invite-link/{token}": { "get": { "tags": [ "Auth" ], "parameters": [ { "name": "token", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/auth/invite-link/redeem": { "post": { "tags": [ "Auth" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RedeemInviteLinkRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/api-keys": { "post": { "tags": [ "API Keys" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApiKeyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "API Keys" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/api-keys/{id}": { "delete": { "tags": [ "API Keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/api-keys/{id}/policy": { "get": { "tags": [ "API Keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "API Keys" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAgentPolicyRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/organizations": { "post": { "tags": [ "Tenancy" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateOrganizationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Tenancy" ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Tenancy" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameOrganizationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Tenancy" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/organizations/region": { "get": { "tags": [ "Tenancy" ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Tenancy" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetOrganizationRegionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/projects": { "post": { "tags": [ "Tenancy" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateProjectRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Tenancy" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/projects/{projectId}": { "put": { "tags": [ "Tenancy" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RenameProjectRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Tenancy" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/members": { "get": { "tags": [ "Tenancy" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/members/{userId}/roles": { "post": { "tags": [ "Tenancy" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeRolesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/members/{userId}/deactivate": { "post": { "tags": [ "Tenancy" ], "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/invitations": { "post": { "tags": [ "Invitations" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvitationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Invitations" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/invitations/{id}/revoke": { "post": { "tags": [ "Invitations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/my/invitations": { "get": { "tags": [ "Invitations" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/my/invitations/{id}/accept": { "post": { "tags": [ "Invitations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/my/invitations/{id}/decline": { "post": { "tags": [ "Invitations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/projects/{projectId}/findings": { "post": { "tags": [ "Findings" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFindingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Findings" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "$ref": "#/components/schemas/FindingStatus" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/findings/search": { "get": { "tags": [ "Findings" ], "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "projectId", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/findings/{id}": { "get": { "tags": [ "Findings" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/findings/{id}/similar": { "get": { "tags": [ "Findings" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/findings/{id}/transition": { "post": { "tags": [ "Findings" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransitionFindingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/findings/{id}/assign": { "post": { "tags": [ "Findings" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssignFindingRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/workflow": { "get": { "tags": [ "Findings" ], "responses": { "200": { "description": "OK" } } }, "put": { "tags": [ "Findings" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SaveWorkflowRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/findings/bulk": { "post": { "tags": [ "Findings" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BulkOperationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/projects/{projectId}/findings/import": { "post": { "tags": [ "Findings" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportFindingsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/agent-actions": { "get": { "tags": [ "Findings" ], "parameters": [ { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "agentKeyId", "in": "query", "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/agent-actions/{id}/approve": { "post": { "tags": [ "Findings" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/agent-actions/{id}/reject": { "post": { "tags": [ "Findings" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/projects/{projectId}/failure-classification": { "post": { "tags": [ "Findings" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ClassifyFailureBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/projects/{projectId}/failure-classification/correct": { "post": { "tags": [ "Findings" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CorrectCategoryBody" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/projects/{projectId}/root-cause-clusters": { "get": { "tags": [ "Findings" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "threshold", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)(?:\\.\\d+)?(?:[eE][+-]?\\d+)?$", "type": [ "number", "string" ], "format": "float" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/findings/{id}/fix-plan": { "get": { "tags": [ "Findings" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/findings/{id}/fix-plan/submit": { "post": { "tags": [ "Findings" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/findings/{findingId}/comments": { "get": { "tags": [ "Comments" ], "parameters": [ { "name": "findingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Comments" ], "parameters": [ { "name": "findingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddCommentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/findings/{findingId}/watch": { "get": { "tags": [ "Watchers" ], "parameters": [ { "name": "findingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Watchers" ], "parameters": [ { "name": "findingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Watchers" ], "parameters": [ { "name": "findingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/findings/{findingId}/evidence": { "post": { "tags": [ "Evidence" ], "parameters": [ { "name": "findingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEvidenceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Evidence" ], "parameters": [ { "name": "findingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/findings/{findingId}/evidence/timeline": { "get": { "tags": [ "Evidence" ], "parameters": [ { "name": "findingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/evidence/{evidenceId}": { "get": { "tags": [ "Evidence" ], "parameters": [ { "name": "evidenceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "delete": { "tags": [ "Evidence" ], "parameters": [ { "name": "evidenceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/evidence/{evidenceId}/trace": { "get": { "tags": [ "Evidence" ], "parameters": [ { "name": "evidenceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/evidence/{evidenceId}/thumbnail": { "get": { "tags": [ "Evidence" ], "parameters": [ { "name": "evidenceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/evidence/{evidenceId}/complete": { "post": { "tags": [ "Evidence" ], "parameters": [ { "name": "evidenceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/evidence/retention/run": { "post": { "tags": [ "Evidence" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/projects/{projectId}/test-runs": { "post": { "tags": [ "Test Automation" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTestRunRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Test Automation" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/projects/{projectId}/test-runs/import": { "post": { "tags": [ "Test Automation" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "format", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/test-runs/{runId}": { "get": { "tags": [ "Test Automation" ], "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/test-runs/{runId}/results": { "post": { "tags": [ "Test Automation" ], "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterResultsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Test Automation" ], "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "pageSize", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/test-runs/{runId}/complete": { "post": { "tags": [ "Test Automation" ], "parameters": [ { "name": "runId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/analytics/projects/{projectId}/suite-health": { "get": { "tags": [ "Analytics" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "interval", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/analytics/projects/{projectId}/throughput": { "get": { "tags": [ "Analytics" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "interval", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/analytics/projects/{projectId}/top-failing": { "get": { "tags": [ "Analytics" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/analytics/projects/{projectId}/top-flaky": { "get": { "tags": [ "Analytics" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/analytics/projects/{projectId}/coverage": { "get": { "tags": [ "Analytics" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Analytics" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "format", "in": "query", "schema": { "type": "string" } }, { "name": "commit", "in": "query", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/analytics/projects/{projectId}/release-readiness": { "get": { "tags": [ "Analytics" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/analytics/projects/{projectId}/suite-health.csv": { "get": { "tags": [ "Analytics" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "interval", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/analytics/projects/{projectId}/throughput.csv": { "get": { "tags": [ "Analytics" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "interval", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/analytics/projects/{projectId}/top-failing.csv": { "get": { "tags": [ "Analytics" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/analytics/projects/{projectId}/top-flaky.csv": { "get": { "tags": [ "Analytics" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/analytics/projects/{projectId}/coverage.csv": { "get": { "tags": [ "Analytics" ], "parameters": [ { "name": "projectId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/billing/status": { "get": { "tags": [ "Billing" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/billing/usage": { "get": { "tags": [ "Billing" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/billing/overage": { "get": { "tags": [ "Billing" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/billing/invoices": { "get": { "tags": [ "Billing" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/billing/plan-change/preview": { "get": { "tags": [ "Billing" ], "parameters": [ { "name": "plan", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "interval", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/billing/checkout": { "post": { "tags": [ "Billing" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCheckoutRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/billing/portal": { "post": { "tags": [ "Billing" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/billing/webhook/{provider}": { "post": { "tags": [ "Billing" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/notifications": { "get": { "tags": [ "Notifications" ], "parameters": [ { "name": "unread", "in": "query", "schema": { "type": "boolean" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/notifications/{id}/read": { "post": { "tags": [ "Notifications" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/notifications/read-all": { "post": { "tags": [ "Notifications" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/webhooks": { "get": { "tags": [ "Webhooks" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Webhooks" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhookRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/webhooks/{id}": { "delete": { "tags": [ "Webhooks" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/webhooks/deliveries": { "get": { "tags": [ "Webhooks" ], "parameters": [ { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/findings/{findingId}/links": { "get": { "tags": [ "GitHub" ], "parameters": [ { "name": "findingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "GitHub" ], "parameters": [ { "name": "findingId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateLinkRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/links/{id}": { "delete": { "tags": [ "GitHub" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations": { "get": { "tags": [ "Integrations" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/{provider}/connect": { "post": { "tags": [ "Integrations" ], "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/{id}": { "delete": { "tags": [ "Integrations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/integrations/{id}/conflicts": { "get": { "tags": [ "Integrations" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/saved-views": { "get": { "tags": [ "Saved Views" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Saved Views" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSavedViewRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/saved-views/{id}": { "delete": { "tags": [ "Saved Views" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/audit": { "get": { "tags": [ "Audit" ], "parameters": [ { "name": "since", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "until", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "action", "in": "query", "schema": { "type": "string" } }, { "name": "resourceType", "in": "query", "schema": { "type": "string" } }, { "name": "actorId", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/audit/export": { "get": { "tags": [ "Audit" ], "parameters": [ { "name": "format", "in": "query", "schema": { "type": "string" } }, { "name": "since", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "until", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "action", "in": "query", "schema": { "type": "string" } }, { "name": "resourceType", "in": "query", "schema": { "type": "string" } }, { "name": "actorId", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/export": { "get": { "tags": [ "Export" ], "parameters": [ { "name": "format", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Export" ], "parameters": [ { "name": "format", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/export/manifest": { "get": { "tags": [ "Export" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/import": { "post": { "tags": [ "Export" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrgExportDocument" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/offboarding": { "get": { "tags": [ "Export" ], "responses": { "200": { "description": "OK" } } }, "post": { "tags": [ "Export" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/offboarding/cancel": { "post": { "tags": [ "Export" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/offboarding/purge": { "post": { "tags": [ "Export" ], "parameters": [ { "name": "confirm", "in": "query", "schema": { "type": "boolean" } }, { "name": "force", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/support/tickets": { "post": { "tags": [ "Support" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSupportTicketRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Support" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/support/tickets/{id}": { "get": { "tags": [ "Support" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/support/staff/break-glass": { "post": { "tags": [ "Support Staff" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestBreakGlassRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } }, "get": { "tags": [ "Support Staff" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/support/staff/break-glass/{id}/activate": { "post": { "tags": [ "Support Staff" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/support/staff/break-glass/{id}/revoke": { "post": { "tags": [ "Support Staff" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/onboarding": { "get": { "tags": [ "Onboarding" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/onboarding/sample": { "post": { "tags": [ "Onboarding" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/status/incidents": { "post": { "tags": [ "Status" ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenIncidentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/status/incidents/{id}/updates": { "post": { "tags": [ "Status" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateIncidentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/status/incidents/{id}/postmortem": { "post": { "tags": [ "Status" ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostmortemRequest" } } }, "required": true }, "responses": { "200": { "description": "OK" } } } }, "/api/v1/trust": { "get": { "tags": [ "Trust" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/trust/subprocessors": { "get": { "tags": [ "Trust" ], "responses": { "200": { "description": "OK" } } } }, "/api/v1/trust/dpa": { "get": { "tags": [ "Trust" ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "AddCommentRequest": { "required": [ "body" ], "type": "object", "properties": { "body": { "type": "string" }, "internal": { "type": "boolean", "default": false } } }, "AssignFindingRequest": { "required": [ "assigneeId" ], "type": "object", "properties": { "assigneeId": { "type": "string" } } }, "AttachmentDto": { "required": [ "id", "findingId", "fileName", "contentType", "size", "kind", "status", "hasThumbnail", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "findingId": { "type": "string" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "size": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "kind": { "type": "string" }, "status": { "type": "string" }, "hasThumbnail": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "hasTrace": { "type": "boolean", "default": false }, "commentId": { "type": [ "null", "string" ] } } }, "AuditActorType": { "enum": [ "User", "Agent", "Support", "System" ] }, "AuditEntry": { "required": [ "id", "sequence", "actorId", "actorType", "organizationId", "action", "resourceType", "occurredAt", "metadata", "prevHash", "hash" ], "type": "object", "properties": { "id": { "type": "string" }, "sequence": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "actorId": { "type": "string" }, "actorType": { "$ref": "#/components/schemas/AuditActorType" }, "actorDisplay": { "type": [ "null", "string" ] }, "organizationId": { "type": "string" }, "action": { "type": "string" }, "resourceType": { "type": "string" }, "resourceId": { "type": [ "null", "string" ] }, "occurredAt": { "type": "string", "format": "date-time" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "correlationId": { "type": [ "null", "string" ] }, "prevHash": { "type": "string" }, "hash": { "type": "string" } } }, "BulkOperationKind": { "enum": [ "Transition", "Assign", "Disposition" ] }, "BulkOperationRequest": { "required": [ "kind", "findingIds" ], "type": "object", "properties": { "kind": { "$ref": "#/components/schemas/BulkOperationKind" }, "findingIds": { "type": "array", "items": { "type": "string" } }, "transition": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/TransitionFindingRequest" } ] }, "assign": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/AssignFindingRequest" } ] }, "disposition": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/DispositionRequest" } ] } } }, "ChangePasswordRequest": { "required": [ "currentPassword", "newPassword" ], "type": "object", "properties": { "currentPassword": { "type": "string" }, "newPassword": { "type": "string" } } }, "ChangeRolesRequest": { "required": [ "roles" ], "type": "object", "properties": { "roles": { "type": "array", "items": { "type": "string" } } } }, "ClassifyFailureBody": { "required": [ "text" ], "type": "object", "properties": { "text": { "type": "string" }, "failureSignature": { "type": [ "null", "string" ] } } }, "CommentDto": { "required": [ "id", "findingId", "authorId", "body", "internal", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "findingId": { "type": "string" }, "authorId": { "type": "string" }, "body": { "type": "string" }, "internal": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } } }, "ConnectRequest": { "type": "object", "properties": { "config": { "type": [ "null", "object" ], "additionalProperties": { "type": "string" } }, "token": { "type": [ "null", "string" ] }, "webhookSecret": { "type": [ "null", "string" ] }, "redirectUri": { "type": [ "null", "string" ] } } }, "CorrectCategoryBody": { "required": [ "category", "text" ], "type": "object", "properties": { "category": { "$ref": "#/components/schemas/FailureCategory" }, "text": { "type": "string" }, "failureSignature": { "type": [ "null", "string" ] } } }, "CreateApiKeyRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "scopes": { "type": [ "null", "array" ], "items": { "type": "string" } }, "projectId": { "type": [ "null", "string" ] } } }, "CreateCheckoutRequest": { "required": [ "plan" ], "type": "object", "properties": { "plan": { "type": "string" }, "interval": { "type": "string", "default": "annual" }, "provider": { "type": "string", "default": "paddle" } } }, "CreateEvidenceRequest": { "required": [ "fileName", "contentType", "kind" ], "type": "object", "properties": { "fileName": { "type": "string" }, "contentType": { "type": [ "null", "string" ] }, "kind": { "type": [ "null", "string" ] }, "size": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64", "default": 0 }, "commentId": { "type": [ "null", "string" ] } } }, "CreateFindingRequest": { "required": [ "projectId", "projectKey", "title", "type", "severity", "priority" ], "type": "object", "properties": { "projectId": { "type": "string" }, "projectKey": { "type": "string" }, "title": { "type": "string" }, "type": { "$ref": "#/components/schemas/FindingType" }, "severity": { "$ref": "#/components/schemas/FindingSeverity" }, "priority": { "$ref": "#/components/schemas/FindingPriority" }, "description": { "type": [ "null", "string" ] }, "source": { "$ref": "#/components/schemas/FindingSource" } } }, "CreateInvitationRequest": { "required": [ "email", "roles" ], "type": "object", "properties": { "email": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } } } }, "CreateIssueRequest": { "required": [ "repository" ], "type": "object", "properties": { "repository": { "type": "string" }, "title": { "type": [ "null", "string" ] }, "body": { "type": [ "null", "string" ] } } }, "CreateLinkRequest": { "required": [ "kind", "url" ], "type": "object", "properties": { "kind": { "type": "string" }, "url": { "type": "string" }, "title": { "type": [ "null", "string" ] }, "externalId": { "type": [ "null", "string" ] } } }, "CreateOrganizationRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "plan": { "type": [ "null", "string" ] }, "region": { "type": [ "null", "string" ] } } }, "CreateProjectRequest": { "required": [ "key", "name" ], "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" } } }, "CreateSavedViewRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "projectId": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "query": { "type": [ "null", "string" ] }, "shared": { "type": "boolean", "default": false } } }, "CreateSupportTicketRequest": { "required": [ "subject", "body" ], "type": "object", "properties": { "subject": { "type": "string" }, "body": { "type": "string" }, "findingId": { "type": [ "null", "string" ] }, "category": { "type": [ "null", "string" ] } } }, "CreateTestRunRequest": { "required": [ "projectId", "projectKey" ], "type": "object", "properties": { "projectId": { "type": "string" }, "projectKey": { "type": "string" }, "branch": { "type": [ "null", "string" ] }, "commit": { "type": [ "null", "string" ] }, "environment": { "type": [ "null", "string" ] }, "ciUrl": { "type": [ "null", "string" ] } } }, "CreateWebhookRequest": { "required": [ "url" ], "type": "object", "properties": { "url": { "type": "string" }, "events": { "type": [ "null", "array" ], "items": { "type": "string" } }, "secret": { "type": [ "null", "string" ] } } }, "DisableMfaRequest": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" } } }, "DispositionRequest": { "required": [ "disposition" ], "type": "object", "properties": { "disposition": { "$ref": "#/components/schemas/FindingDisposition" }, "reason": { "type": [ "null", "string" ] } } }, "EmailDeliverabilityEvent": { "required": [ "email", "type" ], "type": "object", "properties": { "email": { "type": "string" }, "type": { "type": "string" }, "detail": { "type": [ "null", "string" ] } } }, "EnableMfaRequest": { "required": [ "code" ], "type": "object", "properties": { "code": { "type": "string" } } }, "EvidenceExportItem": { "required": [ "attachment", "downloadUrl", "downloadExpiresAt" ], "type": "object", "properties": { "attachment": { "$ref": "#/components/schemas/AttachmentDto" }, "downloadUrl": { "type": [ "null", "string" ] }, "downloadExpiresAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "ExportManifest": { "required": [ "schemaVersion", "organizationId", "organizationSlug", "generatedAt", "counts" ], "type": "object", "properties": { "schemaVersion": { "type": "string" }, "organizationId": { "type": "string" }, "organizationSlug": { "type": "string" }, "generatedAt": { "type": "string", "format": "date-time" }, "counts": { "type": "object", "additionalProperties": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } }, "totalRecords": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "ExportedOrganization": { "required": [ "id", "slug", "name", "plan", "status" ], "type": "object", "properties": { "id": { "type": "string" }, "slug": { "type": "string" }, "name": { "type": "string" }, "plan": { "type": "string" }, "status": { "type": "string" } } }, "ExternalIssue": { "required": [ "externalId", "title", "description", "severity", "status", "url" ], "type": "object", "properties": { "externalId": { "type": "string" }, "title": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "severity": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "url": { "type": [ "null", "string" ] }, "labels": { "type": [ "null", "string" ] } } }, "FailureCategory": { "enum": [ "Unknown", "ProductBug", "UiTiming", "Environment", "DataParallelism", "Flaky", "SuiteConfig" ] }, "FindingDisposition": { "enum": [ "Fixed", "WontFix", "AcceptedRisk", "Duplicate", "NotReproducible", null ] }, "FindingDto": { "required": [ "id", "projectId", "key", "title", "description", "type", "severity", "priority", "status", "assignedToId", "createdById", "source", "labels", "reopenCount", "commentCount", "evidenceCount", "createdAt", "updatedAt", "resolvedAt", "closedAt", "test" ], "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "key": { "type": "string" }, "title": { "type": "string" }, "description": { "type": [ "null", "string" ] }, "type": { "$ref": "#/components/schemas/FindingType" }, "severity": { "$ref": "#/components/schemas/FindingSeverity" }, "priority": { "$ref": "#/components/schemas/FindingPriority" }, "status": { "$ref": "#/components/schemas/FindingStatus" }, "assignedToId": { "type": [ "null", "string" ] }, "createdById": { "type": "string" }, "source": { "$ref": "#/components/schemas/FindingSource" }, "labels": { "type": "array", "items": { "type": "string" } }, "reopenCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "commentCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "evidenceCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" }, "resolvedAt": { "type": [ "null", "string" ], "format": "date-time" }, "closedAt": { "type": [ "null", "string" ], "format": "date-time" }, "test": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/FindingTestDto" } ] }, "customStatus": { "type": [ "null", "string" ] }, "disposition": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/FindingDisposition" } ] }, "resolutionReason": { "type": [ "null", "string" ] } } }, "FindingLinkDto": { "required": [ "id", "findingId", "kind", "url", "title", "externalId", "state", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "findingId": { "type": "string" }, "kind": { "type": "string" }, "url": { "type": "string" }, "title": { "type": [ "null", "string" ] }, "externalId": { "type": [ "null", "string" ] }, "state": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "FindingPriority": { "enum": [ "P0", "P1", "P2", "P3", "P4" ] }, "FindingSeverity": { "enum": [ "Critical", "High", "Medium", "Low", "Informational" ] }, "FindingSource": { "enum": [ "Manual", "TestAutomation", "Agent", "Api", "Import", "Integration" ], "default": "Manual" }, "FindingStatus": { "enum": [ "New", "Triaged", "Accepted", "InProgress", "WaitingForInfo", "ReadyForRetest", "Resolved", "Reopened", "Closed", "Rejected", "Duplicate", null ] }, "FindingTestDto": { "required": [ "failureSignature", "lastRunId", "branch", "commit", "occurrenceCount", "firstSeenAt", "lastSeenAt" ], "type": "object", "properties": { "failureSignature": { "type": "string" }, "lastRunId": { "type": [ "null", "string" ] }, "branch": { "type": [ "null", "string" ] }, "commit": { "type": [ "null", "string" ] }, "occurrenceCount": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "firstSeenAt": { "type": "string", "format": "date-time" }, "lastSeenAt": { "type": "string", "format": "date-time" } } }, "FindingType": { "enum": [ "Bug", "Incident", "Observation", "Improvement", "FunctionalFeedback", "Risk", "Question", "Regression", "TestFailure" ] }, "GitHubIssueRequest": { "type": "object", "properties": { "repository": { "type": [ "null", "string" ] } } }, "GitLabLinkRequest": { "required": [ "kind", "url" ], "type": "object", "properties": { "kind": { "type": "string" }, "url": { "type": "string" }, "externalId": { "type": [ "null", "string" ] }, "title": { "type": [ "null", "string" ] } } }, "ImportFindingsRequest": { "required": [ "provider", "connectionId", "issues" ], "type": "object", "properties": { "provider": { "$ref": "#/components/schemas/ImportProvider" }, "connectionId": { "type": "string" }, "issues": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalIssue" } } } }, "ImportProvider": { "enum": [ "Jira", "GitHubIssues", "Sentry" ] }, "IncidentSeverity": { "enum": [ "Minor", "Major", "Critical" ] }, "IncidentStatus": { "enum": [ "Investigating", "Identified", "Monitoring", "Resolved" ] }, "LoginRequest": { "required": [ "email", "password" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" }, "totpCode": { "type": [ "null", "string" ] } } }, "LoginWithCodeRequest": { "required": [ "email", "code" ], "type": "object", "properties": { "email": { "type": "string" }, "code": { "type": "string" } } }, "OpenIncidentRequest": { "required": [ "title", "severity", "message", "affectedComponents" ], "type": "object", "properties": { "title": { "type": "string" }, "severity": { "$ref": "#/components/schemas/IncidentSeverity" }, "message": { "type": "string" }, "affectedComponents": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "OrgExportDocument": { "required": [ "manifest", "organization", "projects", "findings", "comments", "testRuns", "testResults", "evidence", "findingLinks", "savedViews", "auditLog" ], "type": "object", "properties": { "manifest": { "$ref": "#/components/schemas/ExportManifest" }, "organization": { "$ref": "#/components/schemas/ExportedOrganization" }, "projects": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } }, "findings": { "type": "array", "items": { "$ref": "#/components/schemas/FindingDto" } }, "comments": { "type": "array", "items": { "$ref": "#/components/schemas/CommentDto" } }, "testRuns": { "type": "array", "items": { "$ref": "#/components/schemas/TestRunDto" } }, "testResults": { "type": "array", "items": { "$ref": "#/components/schemas/TestResultDto" } }, "evidence": { "type": "array", "items": { "$ref": "#/components/schemas/EvidenceExportItem" } }, "findingLinks": { "type": "array", "items": { "$ref": "#/components/schemas/FindingLinkDto" } }, "savedViews": { "type": "array", "items": { "$ref": "#/components/schemas/SavedViewDto" } }, "auditLog": { "type": "array", "items": { "$ref": "#/components/schemas/AuditEntry" } } } }, "PostmortemRequest": { "required": [ "postmortem" ], "type": "object", "properties": { "postmortem": { "type": [ "null", "string" ] } } }, "ProjectDto": { "required": [ "id", "key", "name", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } } }, "RedeemInviteLinkRequest": { "required": [ "token", "name" ], "type": "object", "properties": { "token": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] } } }, "RedeemTicketLinkRequest": { "required": [ "token" ], "type": "object", "properties": { "token": { "type": "string" } } }, "RefreshRequest": { "required": [ "refreshToken" ], "type": "object", "properties": { "refreshToken": { "type": "string" }, "rotate": { "type": "boolean", "default": false } } }, "RegisterRequest": { "required": [ "email", "name" ], "type": "object", "properties": { "email": { "type": "string" }, "name": { "type": "string" }, "password": { "type": [ "null", "string" ] }, "captchaToken": { "type": [ "null", "string" ] }, "clientIp": { "type": [ "null", "string" ] } } }, "RegisterResultsRequest": { "required": [ "results" ], "type": "object", "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/TestResultInput" } } } }, "RenameOrganizationRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } } }, "RenameProjectRequest": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" } } }, "RequestBreakGlassRequest": { "required": [ "orgSlug", "reason", "durationMinutes" ], "type": "object", "properties": { "orgSlug": { "type": "string" }, "reason": { "type": "string" }, "durationMinutes": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" } } }, "RequestLoginCodeRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" }, "captchaToken": { "type": [ "null", "string" ] }, "clientIp": { "type": [ "null", "string" ] } } }, "RequestPasswordResetRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } } }, "ResetPasswordRequest": { "required": [ "token", "newPassword" ], "type": "object", "properties": { "token": { "type": "string" }, "newPassword": { "type": "string" } } }, "SaveWorkflowRequest": { "required": [ "name", "statuses", "transitions" ], "type": "object", "properties": { "name": { "type": "string" }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowStatusDto" } }, "transitions": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowTransitionDto" } } } }, "SavedViewDto": { "required": [ "id", "name", "ownerUserId", "projectId", "type", "status", "query", "shared", "mine", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "ownerUserId": { "type": "string" }, "projectId": { "type": [ "null", "string" ] }, "type": { "type": [ "null", "string" ] }, "status": { "type": [ "null", "string" ] }, "query": { "type": [ "null", "string" ] }, "shared": { "type": "boolean" }, "mine": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" } } }, "SetAgentPolicyRequest": { "required": [ "mode" ], "type": "object", "properties": { "mode": { "type": "string" }, "allowedTools": { "type": [ "null", "array" ], "items": { "type": "string" } }, "maxActionsPerHour": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "null", "integer", "string" ], "format": "int32" } } }, "SetLastOrganizationRequest": { "required": [ "slug" ], "type": "object", "properties": { "slug": { "type": "string" } } }, "SetOrganizationRegionRequest": { "required": [ "region" ], "type": "object", "properties": { "region": { "type": "string" } } }, "TestOutcome": { "enum": [ "Passed", "Failed", "Skipped", "TimedOut" ] }, "TestResultDto": { "required": [ "id", "runId", "name", "suite", "file", "outcome", "durationMs", "retries", "errorMessage", "failureSignature", "findingId", "createdAt" ], "type": "object", "properties": { "id": { "type": "string" }, "runId": { "type": "string" }, "name": { "type": "string" }, "suite": { "type": [ "null", "string" ] }, "file": { "type": [ "null", "string" ] }, "outcome": { "$ref": "#/components/schemas/TestOutcome" }, "durationMs": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64" }, "retries": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "errorMessage": { "type": [ "null", "string" ] }, "failureSignature": { "type": [ "null", "string" ] }, "findingId": { "type": [ "null", "string" ] }, "createdAt": { "type": "string", "format": "date-time" } } }, "TestResultInput": { "required": [ "name", "outcome" ], "type": "object", "properties": { "name": { "type": "string" }, "outcome": { "$ref": "#/components/schemas/TestOutcome" }, "suite": { "type": [ "null", "string" ] }, "file": { "type": [ "null", "string" ] }, "durationMs": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int64", "default": 0 }, "retries": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32", "default": 0 }, "errorMessage": { "type": [ "null", "string" ] } } }, "TestRunDto": { "required": [ "id", "projectId", "projectKey", "branch", "commit", "environment", "ciUrl", "status", "total", "passed", "failed", "skipped", "startedAt", "completedAt" ], "type": "object", "properties": { "id": { "type": "string" }, "projectId": { "type": "string" }, "projectKey": { "type": "string" }, "branch": { "type": [ "null", "string" ] }, "commit": { "type": [ "null", "string" ] }, "environment": { "type": [ "null", "string" ] }, "ciUrl": { "type": [ "null", "string" ] }, "status": { "$ref": "#/components/schemas/TestRunStatus" }, "total": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "passed": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "failed": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "skipped": { "pattern": "^-?(?:0|[1-9]\\d*)$", "type": [ "integer", "string" ], "format": "int32" }, "startedAt": { "type": "string", "format": "date-time" }, "completedAt": { "type": [ "null", "string" ], "format": "date-time" } } }, "TestRunStatus": { "enum": [ "Running", "Completed", "Aborted" ] }, "TransitionFindingRequest": { "required": [ "to" ], "type": "object", "properties": { "to": { "type": "string" }, "disposition": { "oneOf": [ { "type": "null" }, { "$ref": "#/components/schemas/FindingDisposition" } ] }, "reason": { "type": [ "null", "string" ] } } }, "UpdateIncidentRequest": { "required": [ "status", "message" ], "type": "object", "properties": { "status": { "$ref": "#/components/schemas/IncidentStatus" }, "message": { "type": [ "null", "string" ] } } }, "VerifyEmailRequest": { "required": [ "token" ], "type": "object", "properties": { "token": { "type": "string" } } }, "WorkflowStatusDto": { "required": [ "name" ], "type": "object", "properties": { "name": { "type": "string" }, "isTerminal": { "type": "boolean", "default": false }, "requiredFields": { "type": [ "null", "array" ], "items": { "type": "string" } } } }, "WorkflowTransitionDto": { "required": [ "from", "to" ], "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" }, "requiredFields": { "type": [ "null", "array" ], "items": { "type": "string" } } } } } }, "tags": [ { "name": "Test Automation" }, { "name": "Email" }, { "name": "GitHub" }, { "name": "Integrations" }, { "name": "Support" }, { "name": "Support Staff" }, { "name": "Status" }, { "name": "MCP" }, { "name": "Auth" }, { "name": "API Keys" }, { "name": "Tenancy" }, { "name": "Invitations" }, { "name": "Findings" }, { "name": "Comments" }, { "name": "Watchers" }, { "name": "Evidence" }, { "name": "Analytics" }, { "name": "Billing" }, { "name": "Notifications" }, { "name": "Webhooks" }, { "name": "Saved Views" }, { "name": "Audit" }, { "name": "Export" }, { "name": "Onboarding" }, { "name": "Trust" } ] }