{ "components": { "responses": { "TooManyRequests": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Too many requests. A credential makes at most 300 requests per minute, and a client IP at most 600. Retry after the Retry-After delay.", "headers": { "Retry-After": { "description": "Seconds until the limit admits a request.", "schema": { "minimum": 1, "type": "integer" } } } } }, "schemas": { "AccountShareView": { "additionalProperties": false, "properties": { "account_id": { "format": "uuid", "title": "Account Id", "type": "string" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "format": "uuid", "title": "Created By", "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "email": { "default": null, "maxLength": 320, "minLength": 3, "title": "Email", "type": "string" }, "job_id": { "format": "uuid", "title": "Job Id", "type": "string" } }, "required": [ "job_id", "account_id", "display_name", "created_by", "created_at" ], "title": "AccountShareView", "type": "object" }, "AuditParameters": { "$defs": { "ZcDocumentRequest": { "additionalProperties": false, "properties": { "description": { "cli_flag": "--description", "description": "What the preceding document contains and why it matters to the audit: one line, at most 240 characters.", "maxLength": 240, "minLength": 1, "title": "Description", "type": "string" }, "name": { "cli_flag": "--document", "description": "Name of the uploaded context document.", "maxLength": 255, "minLength": 1, "pattern": "^[^/\\\\\\x00-\\x1f\\x7f]+$", "title": "Name", "type": "string" }, "title": { "cli_flag": "--title", "description": "Title of the preceding document: one line, at most 120 characters.", "maxLength": 120, "minLength": 1, "title": "Title", "type": "string" } }, "required": [ "name", "title", "description" ], "title": "ZcDocumentRequest", "type": "object" }, "ZcTargetRequest": { "additionalProperties": false, "properties": { "base_commit": { "anyOf": [ { "pattern": "^(?:[0-9a-f]{40}|[0-9a-f]{64})$", "type": "string" }, { "type": "null" } ], "cli_flag": "--base", "default": null, "description": "Base commit for a root review. Fork fix reviews derive their base.", "title": "Base Commit" }, "exclusions": { "cli_flag": "--exclude", "default": [], "description": "Repository paths, directories or globs to exclude.", "items": { "pattern": "^[^\\r\\n]*\\S[^\\r\\n]*$", "type": "string" }, "title": "Exclusions", "type": "array" }, "scope": { "cli_flag": "--scope", "description": "Repository paths, directories or globs to include.", "items": { "pattern": "^[^\\r\\n]*\\S[^\\r\\n]*$", "type": "string" }, "minItems": 1, "title": "Scope", "type": "array" }, "source_commit": { "cli_flag": "--commit", "description": "Full hash of the pushed commit to audit.", "pattern": "^(?:[0-9a-f]{40}|[0-9a-f]{64})$", "title": "Source Commit", "type": "string" }, "source_url": { "anyOf": [ { "minLength": 1, "type": "string" }, { "type": "null" } ], "cli_flag": "--repo", "description": "Repository URL.", "title": "Source Url" }, "target_id": { "cli_flag": "--target", "description": "Stable identifier for this target within the audit.", "pattern": "^[A-Za-z0-9](?:[A-Za-z0-9._-]{0,99})$", "title": "Target Id", "type": "string" } }, "required": [ "target_id", "source_url", "source_commit", "scope" ], "title": "ZcTargetRequest", "type": "object" } }, "additionalProperties": false, "properties": { "audit_mode": { "cli_flag": "--mode", "cli_value_names": { "light": "agile" }, "description": "Audit mode. Default: Deep for full audits, Agile for reviews.", "enum": [ "light", "deep" ], "job_type_defaults": { "diff_review": "light", "fix_review": "light", "scan": "deep" }, "title": "Audit Mode", "type": "string" }, "credits": { "anyOf": [ { "minimum": 1, "type": "integer" }, { "type": "null" } ], "cli_flag": "--credits", "default": null, "description": "Credits to spend on the audit. Default: the suggested amount for the scope. More credits let the agents explore further.", "title": "Credits" }, "documents": { "default": [], "items": { "$ref": "#/components/schemas/AuditParameters/$defs/ZcDocumentRequest" }, "title": "Documents", "type": "array" }, "focus": { "anyOf": [ { "minLength": 1, "pattern": "(?s)^.*\\S.*$", "type": "string" }, { "type": "null" } ], "cli_flag": "--focus", "default": null, "description": "Audit priorities.", "title": "Focus" }, "job_type": { "cli_flag": "--type", "description": "Audit type. Reviews compare commits; fix reviews verify findings.", "enum": [ "scan", "fix_review", "diff_review" ], "title": "Job Type", "type": "string" }, "name": { "cli_flag": "--name", "description": "Audit name.", "minLength": 1, "title": "Name", "type": "string" }, "poc_policy": { "cli_flag": "--poc", "default": "medium", "description": "Findings that get a proof-of-concept test: all, the given severity and higher, or none (skip).", "enum": [ "all", "low", "medium", "high", "skip" ], "title": "Poc Policy", "type": "string" }, "program_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "cli_flag": "--program-url", "default": null, "description": "Program or engagement URL.", "title": "Program Url" }, "report_format": { "cli_flag": "--report-format", "default": "zc", "description": "Finding report format.", "enum": [ "zc", "cantina", "sherlock", "hackenproof", "yaudit", "cyfrin" ], "title": "Report Format", "type": "string" }, "targets": { "items": { "$ref": "#/components/schemas/AuditParameters/$defs/ZcTargetRequest" }, "minItems": 1, "title": "Targets", "type": "array" } }, "required": [ "job_type", "targets", "audit_mode" ], "title": "ZcJobRequest", "type": "object" }, "BillingView": { "$defs": { "CreditEntry": { "additionalProperties": false, "properties": { "amount": { "maximum": 999999999999, "minimum": -999999999999, "title": "Amount", "type": "integer" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "job_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Job Id" }, "job_workspace_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Job Workspace Id" }, "reason": { "title": "Reason", "type": "string" } }, "required": [ "id", "job_id", "job_workspace_id", "amount", "reason", "created_at" ], "title": "CreditEntry", "type": "object" }, "WorkspaceFunding": { "additionalProperties": false, "properties": { "committed_credits": { "maximum": 999999999999, "minimum": -999999999999, "title": "Committed Credits", "type": "integer" }, "funding_workspace_id": { "format": "uuid", "title": "Funding Workspace Id", "type": "string" }, "lifetime_credit_limit": { "maximum": 999999999999, "minimum": 0, "title": "Lifetime Credit Limit", "type": "integer" } }, "required": [ "funding_workspace_id", "lifetime_credit_limit", "committed_credits" ], "title": "WorkspaceFunding", "type": "object" } }, "additionalProperties": false, "properties": { "balance": { "maximum": 999999999999, "minimum": -999999999999, "title": "Balance", "type": "integer" }, "entries": { "items": { "$ref": "#/components/schemas/BillingView/$defs/CreditEntry" }, "title": "Entries", "type": "array" }, "funding": { "anyOf": [ { "$ref": "#/components/schemas/BillingView/$defs/WorkspaceFunding" }, { "type": "null" } ] }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "balance", "funding", "entries", "next_cursor" ], "title": "BillingView", "type": "object" }, "CancelJob": { "additionalProperties": false, "properties": { "reason": { "default": "platform cancellation requested", "maxLength": 500, "minLength": 1, "title": "Reason", "type": "string" } }, "title": "CancelJob", "type": "object" }, "ContextFile": { "$defs": { "ContextFileJob": { "additionalProperties": false, "properties": { "id": { "format": "uuid", "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "name" ], "title": "ContextFileJob", "type": "object" } }, "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "jobs": { "items": { "$ref": "#/components/schemas/ContextFile/$defs/ContextFileJob" }, "title": "Jobs", "type": "array" }, "name": { "minLength": 1, "title": "Name", "type": "string" }, "size_bytes": { "minimum": 0, "title": "Size Bytes", "type": "integer" } }, "required": [ "id", "name", "size_bytes", "created_at", "jobs" ], "title": "ContextFile", "type": "object" }, "CreateAccountShare": { "additionalProperties": false, "properties": { "email": { "maxLength": 320, "minLength": 3, "title": "Email", "type": "string" } }, "required": [ "email" ], "title": "CreateAccountShare", "type": "object" }, "CreateFundedWorkspace": { "additionalProperties": false, "properties": { "lifetime_credit_limit": { "maximum": 999999999999, "minimum": 0, "title": "Lifetime Credit Limit", "type": "integer" }, "name": { "maxLength": 200, "minLength": 1, "title": "Name", "type": "string" } }, "required": [ "lifetime_credit_limit", "name" ], "title": "CreateFundedWorkspace", "type": "object" }, "CreateInvitation": { "additionalProperties": false, "properties": { "email": { "maxLength": 320, "minLength": 3, "title": "Email", "type": "string" }, "expires_in_hours": { "default": 168, "maximum": 720, "minimum": 1, "title": "Expires In Hours", "type": "integer" }, "role": { "enum": [ "viewer", "member", "admin" ], "title": "Role", "type": "string" } }, "required": [ "email", "role" ], "title": "CreateInvitation", "type": "object" }, "CreateJob": { "$defs": {}, "additionalProperties": false, "properties": { "allow_missing_dependencies": { "default": false, "title": "Allow Missing Dependencies", "type": "boolean" }, "context_file_ids": { "default": [], "items": { "format": "uuid", "type": "string" }, "title": "Context File Ids", "type": "array" }, "knowledge_carryover": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the Job builds on the earlier Jobs of its workspace: it reads their findings and the workspace's known issues. Without a value, a new Job uses them and a fork keeps its parent's choice. When false, the Job reads only its own fork chain. The choice is fixed at launch.", "title": "Knowledge Carryover" }, "parameters": { "$ref": "#/components/schemas/AuditParameters" }, "parent_job_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Job Id" } }, "required": [ "parameters" ], "title": "CreateJob", "type": "object" }, "CreatePlatformArtifact": { "$defs": { "JsonValue": {} }, "additionalProperties": false, "properties": { "data": { "additionalProperties": { "$ref": "#/components/schemas/CreatePlatformArtifact/$defs/JsonValue" }, "title": "Data", "type": "object" }, "kind": { "minLength": 1, "title": "Kind", "type": "string" } }, "required": [ "kind", "data" ], "title": "CreatePlatformArtifact", "type": "object" }, "CreateShare": { "additionalProperties": false, "properties": { "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "default": null, "title": "Expires At" }, "label": { "anyOf": [ { "maxLength": 100, "minLength": 1, "type": "string" }, { "type": "null" } ], "default": null, "title": "Label" } }, "title": "CreateShare", "type": "object" }, "Error": { "properties": { "error": { "type": "string" }, "field": { "type": "string" } }, "required": [ "error" ], "type": "object" }, "EventPage": { "$defs": { "EventView": { "additionalProperties": false, "properties": { "category": { "anyOf": [ { "enum": [ "milestone", "progress", "health" ], "type": "string" }, { "type": "null" } ], "title": "Category" }, "data": { "additionalProperties": { "$ref": "#/components/schemas/EventPage/$defs/JsonValue" }, "title": "Data", "type": "object" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "job_id": { "format": "uuid", "title": "Job Id", "type": "string" }, "kind": { "minLength": 1, "title": "Kind", "type": "string" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" }, "level": { "enum": [ "info", "warning", "error" ], "title": "Level", "type": "string" }, "timestamp": { "format": "date-time", "title": "Timestamp", "type": "string" } }, "required": [ "id", "job_id", "timestamp", "level", "kind", "data", "label", "category" ], "title": "EventView", "type": "object" }, "JsonValue": {} }, "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/EventPage/$defs/EventView" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "EventPage", "type": "object" }, "FundedWorkspace": { "$defs": { "WorkspaceFunding": { "additionalProperties": false, "properties": { "committed_credits": { "maximum": 999999999999, "minimum": -999999999999, "title": "Committed Credits", "type": "integer" }, "funding_workspace_id": { "format": "uuid", "title": "Funding Workspace Id", "type": "string" }, "lifetime_credit_limit": { "maximum": 999999999999, "minimum": 0, "title": "Lifetime Credit Limit", "type": "integer" } }, "required": [ "funding_workspace_id", "lifetime_credit_limit", "committed_credits" ], "title": "WorkspaceFunding", "type": "object" } }, "additionalProperties": false, "properties": { "archived_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Archived At" }, "balance": { "maximum": 999999999999, "minimum": -999999999999, "title": "Balance", "type": "integer" }, "funding": { "$ref": "#/components/schemas/FundedWorkspace/$defs/WorkspaceFunding" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" } }, "required": [ "id", "name", "archived_at", "funding", "balance" ], "title": "FundedWorkspace", "type": "object" }, "FundingChange": { "$defs": { "AccountName": { "additionalProperties": false, "properties": { "account_id": { "format": "uuid", "title": "Account Id", "type": "string" }, "avatar_url": { "default": null, "format": "uri", "minLength": 1, "title": "Avatar Url", "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" } }, "required": [ "account_id", "display_name" ], "title": "AccountName", "type": "object" } }, "additionalProperties": false, "properties": { "action": { "enum": [ "workspace.funded", "workspace.funding_limit_changed", "workspace.detached" ], "title": "Action", "type": "string" }, "actor": { "$ref": "#/components/schemas/FundingChange/$defs/AccountName" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "lifetime_credit_limit": { "anyOf": [ { "maximum": 999999999999, "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Lifetime Credit Limit" }, "previous_limit": { "anyOf": [ { "maximum": 999999999999, "minimum": 0, "type": "integer" }, { "type": "null" } ], "title": "Previous Limit" }, "team_workspace_id": { "format": "uuid", "title": "Team Workspace Id", "type": "string" }, "timestamp": { "format": "date-time", "title": "Timestamp", "type": "string" } }, "required": [ "id", "timestamp", "actor", "team_workspace_id", "action", "previous_limit", "lifetime_credit_limit" ], "title": "FundingChange", "type": "object" }, "Invitation": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "email": { "maxLength": 320, "minLength": 3, "title": "Email", "type": "string" }, "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "role": { "enum": [ "viewer", "member", "admin" ], "title": "Role", "type": "string" }, "workspace_id": { "format": "uuid", "title": "Workspace Id", "type": "string" } }, "required": [ "id", "workspace_id", "email", "role", "expires_at", "created_at" ], "title": "Invitation", "type": "object" }, "IssuedShare": { "$defs": { "ShareView": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Created By" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "job_id": { "format": "uuid", "title": "Job Id", "type": "string" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" } }, "required": [ "id", "job_id", "label", "created_by", "created_at", "expires_at" ], "title": "ShareView", "type": "object" } }, "additionalProperties": false, "properties": { "share": { "$ref": "#/components/schemas/IssuedShare/$defs/ShareView" }, "token": { "title": "Token", "type": "string" } }, "required": [ "share", "token" ], "title": "IssuedShare", "type": "object" }, "Job": { "$defs": { "AccountName": { "additionalProperties": false, "properties": { "account_id": { "format": "uuid", "title": "Account Id", "type": "string" }, "avatar_url": { "default": null, "format": "uri", "minLength": 1, "title": "Avatar Url", "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" } }, "required": [ "account_id", "display_name" ], "title": "AccountName", "type": "object" }, "JobActions": { "properties": { "add_platform_artifacts": { "title": "Add Platform Artifacts", "type": "boolean" }, "cancel": { "title": "Cancel", "type": "boolean" }, "fork": { "title": "Fork", "type": "boolean" }, "rename": { "title": "Rename", "type": "boolean" }, "resume": { "title": "Resume", "type": "boolean" } }, "required": [ "cancel", "resume", "rename", "add_platform_artifacts", "fork" ], "title": "JobActions", "type": "object" }, "JobCredits": { "additionalProperties": false, "properties": { "charge": { "anyOf": [ { "maximum": 999999999999, "minimum": -999999999999, "type": "integer" }, { "type": "null" } ], "title": "Charge" }, "price": { "maximum": 999999999999, "minimum": -999999999999, "title": "Price", "type": "integer" } }, "required": [ "price", "charge" ], "title": "JobCredits", "type": "object" }, "JsonValue": {}, "MissingDependency": { "additionalProperties": false, "properties": { "path": { "maxLength": 4096, "minLength": 1, "title": "Path", "type": "string" }, "target_id": { "maxLength": 100, "minLength": 1, "title": "Target Id", "type": "string" } }, "required": [ "target_id", "path" ], "title": "MissingDependency", "type": "object" } }, "additionalProperties": false, "properties": { "actions": { "$ref": "#/components/schemas/Job/$defs/JobActions" }, "allow_missing_dependencies": { "default": null, "title": "Allow Missing Dependencies", "type": "boolean" }, "context_file_ids": { "default": null, "items": { "format": "uuid", "type": "string" }, "title": "Context File Ids", "type": "array" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "credits": { "anyOf": [ { "$ref": "#/components/schemas/Job/$defs/JobCredits" }, { "type": "null" } ], "default": null }, "execution": { "enum": [ "managed", "standalone", "imported" ], "title": "Execution", "type": "string" }, "favorite": { "default": null, "title": "Favorite", "type": "boolean" }, "fork_request": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/Job/$defs/JsonValue" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Fork Request" }, "hold": { "anyOf": [ { "enum": [ "pause", "spend_limit", "review", "local" ], "type": "string" }, { "type": "null" } ], "title": "Hold" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "knowledge_carryover": { "default": null, "description": "Whether the Job builds on the earlier Jobs of its workspace: it reads their findings and the workspace's known issues. When false, the Job reads only its own fork chain. The choice is fixed at launch.", "title": "Knowledge Carryover", "type": "boolean" }, "missing_dependencies": { "items": { "$ref": "#/components/schemas/Job/$defs/MissingDependency" }, "title": "Missing Dependencies", "type": "array" }, "parent_job_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Parent Job Id" }, "request": { "additionalProperties": { "$ref": "#/components/schemas/Job/$defs/JsonValue" }, "title": "Request", "type": "object" }, "requester": { "$ref": "#/components/schemas/Job/$defs/AccountName", "default": null, "title": "Requester" }, "result": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/Job/$defs/JsonValue" }, "type": "object" }, { "type": "null" } ], "title": "Result" }, "status": { "enum": [ "queued", "running", "completed", "interrupted", "failed", "cancelled" ], "title": "Status", "type": "string" }, "status_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Message" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "workspace_id": { "default": null, "format": "uuid", "title": "Workspace Id", "type": "string" } }, "required": [ "id", "request", "status", "execution", "hold", "result", "status_message", "missing_dependencies", "actions", "parent_job_id", "created_at", "updated_at" ], "title": "Job", "type": "object" }, "JobAdmission": { "$defs": { "AccountName": { "additionalProperties": false, "properties": { "account_id": { "format": "uuid", "title": "Account Id", "type": "string" }, "avatar_url": { "default": null, "format": "uri", "minLength": 1, "title": "Avatar Url", "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" } }, "required": [ "account_id", "display_name" ], "title": "AccountName", "type": "object" }, "Job": { "additionalProperties": false, "properties": { "actions": { "$ref": "#/components/schemas/JobAdmission/$defs/JobActions" }, "allow_missing_dependencies": { "default": null, "title": "Allow Missing Dependencies", "type": "boolean" }, "context_file_ids": { "default": null, "items": { "format": "uuid", "type": "string" }, "title": "Context File Ids", "type": "array" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "credits": { "anyOf": [ { "$ref": "#/components/schemas/JobAdmission/$defs/JobCredits" }, { "type": "null" } ], "default": null }, "execution": { "enum": [ "managed", "standalone", "imported" ], "title": "Execution", "type": "string" }, "favorite": { "default": null, "title": "Favorite", "type": "boolean" }, "fork_request": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/JobAdmission/$defs/JsonValue" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Fork Request" }, "hold": { "anyOf": [ { "enum": [ "pause", "spend_limit", "review", "local" ], "type": "string" }, { "type": "null" } ], "title": "Hold" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "knowledge_carryover": { "default": null, "description": "Whether the Job builds on the earlier Jobs of its workspace: it reads their findings and the workspace's known issues. When false, the Job reads only its own fork chain. The choice is fixed at launch.", "title": "Knowledge Carryover", "type": "boolean" }, "missing_dependencies": { "items": { "$ref": "#/components/schemas/JobAdmission/$defs/MissingDependency" }, "title": "Missing Dependencies", "type": "array" }, "parent_job_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Parent Job Id" }, "request": { "additionalProperties": { "$ref": "#/components/schemas/JobAdmission/$defs/JsonValue" }, "title": "Request", "type": "object" }, "requester": { "$ref": "#/components/schemas/JobAdmission/$defs/AccountName", "default": null, "title": "Requester" }, "result": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/JobAdmission/$defs/JsonValue" }, "type": "object" }, { "type": "null" } ], "title": "Result" }, "status": { "enum": [ "queued", "running", "completed", "interrupted", "failed", "cancelled" ], "title": "Status", "type": "string" }, "status_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Message" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "workspace_id": { "default": null, "format": "uuid", "title": "Workspace Id", "type": "string" } }, "required": [ "id", "request", "status", "execution", "hold", "result", "status_message", "missing_dependencies", "actions", "parent_job_id", "created_at", "updated_at" ], "title": "Job", "type": "object" }, "JobActions": { "properties": { "add_platform_artifacts": { "title": "Add Platform Artifacts", "type": "boolean" }, "cancel": { "title": "Cancel", "type": "boolean" }, "fork": { "title": "Fork", "type": "boolean" }, "rename": { "title": "Rename", "type": "boolean" }, "resume": { "title": "Resume", "type": "boolean" } }, "required": [ "cancel", "resume", "rename", "add_platform_artifacts", "fork" ], "title": "JobActions", "type": "object" }, "JobCredits": { "additionalProperties": false, "properties": { "charge": { "anyOf": [ { "maximum": 999999999999, "minimum": -999999999999, "type": "integer" }, { "type": "null" } ], "title": "Charge" }, "price": { "maximum": 999999999999, "minimum": -999999999999, "title": "Price", "type": "integer" } }, "required": [ "price", "charge" ], "title": "JobCredits", "type": "object" }, "JsonValue": {}, "MissingDependency": { "additionalProperties": false, "properties": { "path": { "maxLength": 4096, "minLength": 1, "title": "Path", "type": "string" }, "target_id": { "maxLength": 100, "minLength": 1, "title": "Target Id", "type": "string" } }, "required": [ "target_id", "path" ], "title": "MissingDependency", "type": "object" } }, "additionalProperties": false, "properties": { "admission_charge": { "maximum": 999999999999, "minimum": -999999999999, "title": "Admission Charge", "type": "integer" }, "job": { "$ref": "#/components/schemas/JobAdmission/$defs/Job" }, "quoted_price": { "maximum": 999999999999, "minimum": -999999999999, "title": "Quoted Price", "type": "integer" }, "url": { "title": "Url", "type": "string" } }, "required": [ "job", "quoted_price", "admission_charge", "url" ], "title": "JobAdmission", "type": "object" }, "JobPage": { "$defs": { "AccountName": { "additionalProperties": false, "properties": { "account_id": { "format": "uuid", "title": "Account Id", "type": "string" }, "avatar_url": { "default": null, "format": "uri", "minLength": 1, "title": "Avatar Url", "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" } }, "required": [ "account_id", "display_name" ], "title": "AccountName", "type": "object" }, "JobListItem": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "execution": { "enum": [ "managed", "standalone", "imported" ], "title": "Execution", "type": "string" }, "favorite": { "default": null, "title": "Favorite", "type": "boolean" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "parent_job_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Parent Job Id" }, "request": { "additionalProperties": { "$ref": "#/components/schemas/JobPage/$defs/JsonValue" }, "title": "Request", "type": "object" }, "requester": { "$ref": "#/components/schemas/JobPage/$defs/AccountName", "default": null, "title": "Requester" }, "result": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/JobPage/$defs/JsonValue" }, "type": "object" }, { "type": "null" } ], "title": "Result" }, "status": { "enum": [ "queued", "running", "completed", "interrupted", "failed", "cancelled" ], "title": "Status", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "workspace_id": { "default": null, "format": "uuid", "title": "Workspace Id", "type": "string" } }, "required": [ "id", "parent_job_id", "status", "execution", "request", "result", "created_at", "updated_at" ], "title": "JobListItem", "type": "object" }, "JsonValue": {} }, "additionalProperties": false, "properties": { "items": { "items": { "$ref": "#/components/schemas/JobPage/$defs/JobListItem" }, "title": "Items", "type": "array" }, "next_cursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Next Cursor" } }, "required": [ "items", "next_cursor" ], "title": "JobPage", "type": "object" }, "JobQuote": { "$defs": { "JsonValue": {} }, "properties": { "admission_charge": { "maximum": 999999999999, "minimum": -999999999999, "title": "Admission Charge", "type": "integer" }, "inherited": { "additionalProperties": { "$ref": "#/components/schemas/JobQuote/$defs/JsonValue" }, "title": "Inherited", "type": "object" }, "missing_dependencies": { "default": [], "items": { "type": "string" }, "title": "Missing Dependencies", "type": "array" }, "parameters": { "additionalProperties": { "$ref": "#/components/schemas/JobQuote/$defs/JsonValue" }, "title": "Parameters", "type": "object" }, "quoted_price": { "maximum": 999999999999, "minimum": -999999999999, "title": "Quoted Price", "type": "integer" }, "warnings": { "items": { "type": "string" }, "title": "Warnings", "type": "array" } }, "required": [ "parameters", "quoted_price", "admission_charge", "warnings", "inherited" ], "title": "JobQuote", "type": "object" }, "JobView": { "$defs": { "AccountName": { "additionalProperties": false, "properties": { "account_id": { "format": "uuid", "title": "Account Id", "type": "string" }, "avatar_url": { "default": null, "format": "uri", "minLength": 1, "title": "Avatar Url", "type": "string" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" } }, "required": [ "account_id", "display_name" ], "title": "AccountName", "type": "object" }, "CommentRead": { "additionalProperties": false, "properties": { "read_through_at": { "format": "date-time", "title": "Read Through At", "type": "string" }, "target_artifact_id": { "format": "uuid", "title": "Target Artifact Id", "type": "string" } }, "required": [ "target_artifact_id", "read_through_at" ], "title": "CommentRead", "type": "object" }, "Job": { "additionalProperties": false, "properties": { "actions": { "$ref": "#/components/schemas/JobView/$defs/JobActions" }, "allow_missing_dependencies": { "default": null, "title": "Allow Missing Dependencies", "type": "boolean" }, "context_file_ids": { "default": null, "items": { "format": "uuid", "type": "string" }, "title": "Context File Ids", "type": "array" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "credits": { "anyOf": [ { "$ref": "#/components/schemas/JobView/$defs/JobCredits" }, { "type": "null" } ], "default": null }, "execution": { "enum": [ "managed", "standalone", "imported" ], "title": "Execution", "type": "string" }, "favorite": { "default": null, "title": "Favorite", "type": "boolean" }, "fork_request": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/JobView/$defs/JsonValue" }, "type": "object" }, { "type": "null" } ], "default": null, "title": "Fork Request" }, "hold": { "anyOf": [ { "enum": [ "pause", "spend_limit", "review", "local" ], "type": "string" }, { "type": "null" } ], "title": "Hold" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "knowledge_carryover": { "default": null, "description": "Whether the Job builds on the earlier Jobs of its workspace: it reads their findings and the workspace's known issues. When false, the Job reads only its own fork chain. The choice is fixed at launch.", "title": "Knowledge Carryover", "type": "boolean" }, "missing_dependencies": { "items": { "$ref": "#/components/schemas/JobView/$defs/MissingDependency" }, "title": "Missing Dependencies", "type": "array" }, "parent_job_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Parent Job Id" }, "request": { "additionalProperties": { "$ref": "#/components/schemas/JobView/$defs/JsonValue" }, "title": "Request", "type": "object" }, "requester": { "$ref": "#/components/schemas/JobView/$defs/AccountName", "default": null, "title": "Requester" }, "result": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/JobView/$defs/JsonValue" }, "type": "object" }, { "type": "null" } ], "title": "Result" }, "status": { "enum": [ "queued", "running", "completed", "interrupted", "failed", "cancelled" ], "title": "Status", "type": "string" }, "status_message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Status Message" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "workspace_id": { "default": null, "format": "uuid", "title": "Workspace Id", "type": "string" } }, "required": [ "id", "request", "status", "execution", "hold", "result", "status_message", "missing_dependencies", "actions", "parent_job_id", "created_at", "updated_at" ], "title": "Job", "type": "object" }, "JobAccess": { "additionalProperties": false, "properties": { "role": { "anyOf": [ { "enum": [ "viewer", "member", "admin" ], "type": "string" }, { "type": "null" } ], "title": "Role" }, "source": { "enum": [ "workspace_membership", "direct_share", "public_share" ], "title": "Source", "type": "string" }, "visibility": { "enum": [ "public", "client" ], "title": "Visibility", "type": "string" } }, "required": [ "visibility", "role", "source" ], "title": "JobAccess", "type": "object" }, "JobActions": { "properties": { "add_platform_artifacts": { "title": "Add Platform Artifacts", "type": "boolean" }, "cancel": { "title": "Cancel", "type": "boolean" }, "fork": { "title": "Fork", "type": "boolean" }, "rename": { "title": "Rename", "type": "boolean" }, "resume": { "title": "Resume", "type": "boolean" } }, "required": [ "cancel", "resume", "rename", "add_platform_artifacts", "fork" ], "title": "JobActions", "type": "object" }, "JobCredits": { "additionalProperties": false, "properties": { "charge": { "anyOf": [ { "maximum": 999999999999, "minimum": -999999999999, "type": "integer" }, { "type": "null" } ], "title": "Charge" }, "price": { "maximum": 999999999999, "minimum": -999999999999, "title": "Price", "type": "integer" } }, "required": [ "price", "charge" ], "title": "JobCredits", "type": "object" }, "JobListItem": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "execution": { "enum": [ "managed", "standalone", "imported" ], "title": "Execution", "type": "string" }, "favorite": { "default": null, "title": "Favorite", "type": "boolean" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "parent_job_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Parent Job Id" }, "request": { "additionalProperties": { "$ref": "#/components/schemas/JobView/$defs/JsonValue" }, "title": "Request", "type": "object" }, "requester": { "$ref": "#/components/schemas/JobView/$defs/AccountName", "default": null, "title": "Requester" }, "result": { "anyOf": [ { "additionalProperties": { "$ref": "#/components/schemas/JobView/$defs/JsonValue" }, "type": "object" }, { "type": "null" } ], "title": "Result" }, "status": { "enum": [ "queued", "running", "completed", "interrupted", "failed", "cancelled" ], "title": "Status", "type": "string" }, "updated_at": { "format": "date-time", "title": "Updated At", "type": "string" }, "workspace_id": { "default": null, "format": "uuid", "title": "Workspace Id", "type": "string" } }, "required": [ "id", "parent_job_id", "status", "execution", "request", "result", "created_at", "updated_at" ], "title": "JobListItem", "type": "object" }, "JsonValue": {}, "MissingDependency": { "additionalProperties": false, "properties": { "path": { "maxLength": 4096, "minLength": 1, "title": "Path", "type": "string" }, "target_id": { "maxLength": 100, "minLength": 1, "title": "Target Id", "type": "string" } }, "required": [ "target_id", "path" ], "title": "MissingDependency", "type": "object" }, "StoredArtifact": { "additionalProperties": false, "properties": { "data": { "additionalProperties": { "$ref": "#/components/schemas/JobView/$defs/JsonValue" }, "title": "Data", "type": "object" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "job_id": { "format": "uuid", "title": "Job Id", "type": "string" }, "kind": { "title": "Kind", "type": "string" } }, "required": [ "id", "job_id", "kind", "data" ], "title": "StoredArtifact", "type": "object" } }, "additionalProperties": false, "properties": { "access": { "$ref": "#/components/schemas/JobView/$defs/JobAccess" }, "artifacts": { "items": { "$ref": "#/components/schemas/JobView/$defs/StoredArtifact" }, "title": "Artifacts", "type": "array" }, "comment_accounts": { "default": null, "items": { "$ref": "#/components/schemas/JobView/$defs/AccountName" }, "title": "Comment Accounts", "type": "array" }, "comment_reads": { "default": null, "items": { "$ref": "#/components/schemas/JobView/$defs/CommentRead" }, "title": "Comment Reads", "type": "array" }, "findings_without_response": { "default": null, "items": { "format": "uuid", "type": "string" }, "title": "Findings Without Response", "type": "array" }, "job": { "$ref": "#/components/schemas/JobView/$defs/Job" }, "lineage": { "items": { "$ref": "#/components/schemas/JobView/$defs/JobListItem" }, "title": "Lineage", "type": "array" }, "new_findings": { "default": null, "items": { "format": "uuid", "type": "string" }, "title": "New Findings", "type": "array" } }, "required": [ "job", "access", "lineage", "artifacts" ], "title": "JobView", "type": "object" }, "Member": { "additionalProperties": false, "properties": { "account_id": { "format": "uuid", "title": "Account Id", "type": "string" }, "avatar_url": { "anyOf": [ { "format": "uri", "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Avatar Url" }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Display Name" }, "email": { "default": null, "maxLength": 320, "minLength": 3, "title": "Email", "type": "string" }, "role": { "enum": [ "viewer", "member", "admin" ], "title": "Role", "type": "string" } }, "required": [ "account_id", "display_name", "avatar_url", "role" ], "title": "Member", "type": "object" }, "PauseJob": { "additionalProperties": false, "properties": { "reason": { "maxLength": 500, "minLength": 1, "title": "Reason", "type": "string" } }, "required": [ "reason" ], "title": "PauseJob", "type": "object" }, "PullRequestRepository": { "$defs": { "GitHubRepository": { "additionalProperties": false, "properties": { "default_branch": { "minLength": 1, "title": "Default Branch", "type": "string" }, "full_name": { "minLength": 1, "title": "Full Name", "type": "string" }, "id": { "pattern": "^[1-9]\\d*$", "title": "Id", "type": "string" }, "name": { "minLength": 1, "title": "Name", "type": "string" }, "owner": { "minLength": 1, "title": "Owner", "type": "string" }, "private": { "title": "Private", "type": "boolean" }, "url": { "format": "uri", "minLength": 1, "title": "Url", "type": "string" } }, "required": [ "id", "owner", "name", "full_name", "url", "default_branch", "private" ], "title": "GitHubRepository", "type": "object" }, "PullRequestReviewSettings": { "additionalProperties": false, "properties": { "blocking_severity": { "anyOf": [ { "enum": [ "Critical", "High", "Medium", "Low" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Blocking Severity" }, "connection_id": { "format": "uuid", "title": "Connection Id", "type": "string" }, "quote_branches": { "default": [], "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "maxItems": 20, "title": "Quote Branches", "type": "array" }, "result_posting": { "default": "summary", "enum": [ "link", "summary", "report" ], "title": "Result Posting", "type": "string" }, "trigger_role": { "default": "admin", "enum": [ "write", "maintain", "admin" ], "title": "Trigger Role", "type": "string" } }, "required": [ "connection_id" ], "title": "PullRequestReviewSettings", "type": "object" } }, "additionalProperties": false, "properties": { "approval_url": { "anyOf": [ { "format": "uri", "minLength": 1, "type": "string" }, { "type": "null" } ], "title": "Approval Url" }, "connection_id": { "format": "uuid", "title": "Connection Id", "type": "string" }, "enabled_in_other_workspace": { "title": "Enabled In Other Workspace", "type": "boolean" }, "permissions_approved": { "title": "Permissions Approved", "type": "boolean" }, "repository": { "$ref": "#/components/schemas/PullRequestRepository/$defs/GitHubRepository" }, "review_command": { "title": "Review Command", "type": "string" }, "settings": { "anyOf": [ { "$ref": "#/components/schemas/PullRequestRepository/$defs/PullRequestReviewSettings" }, { "type": "null" } ] }, "unenforced_branches": { "items": { "type": "string" }, "title": "Unenforced Branches", "type": "array" } }, "required": [ "repository", "connection_id", "settings", "enabled_in_other_workspace", "permissions_approved", "unenforced_branches", "approval_url", "review_command" ], "title": "PullRequestRepository", "type": "object" }, "PullRequestReview": { "$defs": { "CreateJob": { "additionalProperties": false, "properties": { "allow_missing_dependencies": { "default": false, "title": "Allow Missing Dependencies", "type": "boolean" }, "context_file_ids": { "default": [], "items": { "format": "uuid", "type": "string" }, "title": "Context File Ids", "type": "array" }, "knowledge_carryover": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "default": null, "description": "Whether the Job builds on the earlier Jobs of its workspace: it reads their findings and the workspace's known issues. Without a value, a new Job uses them and a fork keeps its parent's choice. When false, the Job reads only its own fork chain. The choice is fixed at launch.", "title": "Knowledge Carryover" }, "parameters": { "additionalProperties": { "$ref": "#/components/schemas/PullRequestReview/$defs/JsonValue" }, "title": "Parameters", "type": "object" }, "parent_job_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Parent Job Id" } }, "required": [ "parameters" ], "title": "CreateJob", "type": "object" }, "JsonValue": {} }, "additionalProperties": false, "properties": { "head_moved": { "title": "Head Moved", "type": "boolean" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "job_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Job Id" }, "parameter_constraints": { "additionalProperties": { "$ref": "#/components/schemas/PullRequestReview/$defs/JsonValue" }, "title": "Parameter Constraints", "type": "object" }, "pull_number": { "exclusiveMinimum": 0, "title": "Pull Number", "type": "integer" }, "pull_url": { "format": "uri", "minLength": 1, "title": "Pull Url", "type": "string" }, "quoted_price": { "maximum": 999999999999, "minimum": -999999999999, "title": "Quoted Price", "type": "integer" }, "repository": { "title": "Repository", "type": "string" }, "request": { "$ref": "#/components/schemas/PullRequestReview/$defs/CreateJob" }, "review_command": { "title": "Review Command", "type": "string" }, "title": { "title": "Title", "type": "string" } }, "required": [ "id", "repository", "pull_number", "pull_url", "title", "head_moved", "request", "parameter_constraints", "review_command", "quoted_price", "job_id" ], "title": "PullRequestReview", "type": "object" }, "PullRequestReviewSettings": { "additionalProperties": false, "properties": { "blocking_severity": { "anyOf": [ { "enum": [ "Critical", "High", "Medium", "Low" ], "type": "string" }, { "type": "null" } ], "default": null, "title": "Blocking Severity" }, "connection_id": { "format": "uuid", "title": "Connection Id", "type": "string" }, "quote_branches": { "default": [], "items": { "maxLength": 255, "minLength": 1, "type": "string" }, "maxItems": 20, "title": "Quote Branches", "type": "array" }, "result_posting": { "default": "summary", "enum": [ "link", "summary", "report" ], "title": "Result Posting", "type": "string" }, "trigger_role": { "default": "admin", "enum": [ "write", "maintain", "admin" ], "title": "Trigger Role", "type": "string" } }, "required": [ "connection_id" ], "title": "PullRequestReviewSettings", "type": "object" }, "ShareView": { "additionalProperties": false, "properties": { "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "created_by": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Created By" }, "expires_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "title": "Expires At" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "job_id": { "format": "uuid", "title": "Job Id", "type": "string" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Label" } }, "required": [ "id", "job_id", "label", "created_by", "created_at", "expires_at" ], "title": "ShareView", "type": "object" }, "SourceFile": { "additionalProperties": false, "properties": { "content": { "title": "Content", "type": "string" } }, "required": [ "content" ], "title": "SourceFile", "type": "object" }, "SourceFileRequest": { "additionalProperties": false, "properties": { "artifact_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "default": null, "title": "Artifact Id" }, "path": { "maxLength": 4096, "minLength": 1, "title": "Path", "type": "string" }, "target_id": { "maxLength": 100, "minLength": 1, "title": "Target Id", "type": "string" } }, "required": [ "target_id", "path" ], "title": "SourceFileRequest", "type": "object" }, "StoredArtifact": { "$defs": { "JsonValue": {} }, "additionalProperties": false, "properties": { "data": { "additionalProperties": { "$ref": "#/components/schemas/StoredArtifact/$defs/JsonValue" }, "title": "Data", "type": "object" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "job_id": { "format": "uuid", "title": "Job Id", "type": "string" }, "kind": { "title": "Kind", "type": "string" } }, "required": [ "id", "job_id", "kind", "data" ], "title": "StoredArtifact", "type": "object" }, "UpdateFundedWorkspace": { "additionalProperties": false, "properties": { "lifetime_credit_limit": { "maximum": 999999999999, "minimum": 0, "title": "Lifetime Credit Limit", "type": "integer" } }, "required": [ "lifetime_credit_limit" ], "title": "UpdateFundedWorkspace", "type": "object" }, "UpdateMember": { "additionalProperties": false, "properties": { "role": { "enum": [ "viewer", "member", "admin" ], "title": "Role", "type": "string" } }, "required": [ "role" ], "title": "UpdateMember", "type": "object" }, "Workspace": { "properties": { "archived_at": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ], "description": "When the workspace was archived, or null. An archived workspace refuses new Jobs, invitations, context file uploads, GitHub changes, and renames with 409. Its Jobs, findings, and history stay readable.", "title": "Archived At" }, "balance": { "anyOf": [ { "maximum": 999999999999, "minimum": -999999999999, "type": "integer" }, { "type": "null" } ], "title": "Balance" }, "funding_workspace_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Funding Workspace Id" }, "id": { "format": "uuid", "title": "Id", "type": "string" }, "name": { "title": "Name", "type": "string" }, "own_role": { "title": "Own Role", "type": "boolean" }, "role": { "enum": [ "viewer", "member", "admin" ], "title": "Role", "type": "string" } }, "required": [ "id", "name", "archived_at", "funding_workspace_id", "role", "own_role", "balance" ], "title": "Workspace", "type": "object" } }, "securitySchemes": { "bearerAuth": { "scheme": "bearer", "type": "http" } } }, "info": { "title": "Zero Cool API", "version": "current" }, "openapi": "3.1.0", "paths": { "/jobs": { "get": { "parameters": [ { "in": "query", "name": "workspace_id", "schema": { "description": "One workspace. Default: every workspace that the caller reads.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "q", "schema": { "description": "A Job search of the search text that the integration derives from each Job. A space between conditions means AND. A word or a quoted phrase matches text that contains it, ignoring case. A leading - or NOT excludes the Jobs that match a condition. Uppercase OR, AND, and parentheses combine conditions. A fork chain matches when one of its Jobs matches. Only the fields that the caller reads decide a match. An invalid search returns 422 with the reason.", "maxLength": 200, "minLength": 1, "type": "string" } }, { "in": "query", "name": "status", "schema": { "description": "Job status. A fork chain matches status, requester, created_after, and created_before when one of its Jobs matches all of them.", "enum": [ "queued", "running", "completed", "interrupted", "failed", "cancelled" ], "type": "string" } }, { "in": "query", "name": "requester", "schema": { "description": "Account ID that requested the Job. A fork chain matches status, requester, created_after, and created_before when one of its Jobs matches all of them.", "format": "uuid", "type": "string" } }, { "in": "query", "name": "created_after", "schema": { "description": "ISO 8601 time. The Job was created at or after it. A fork chain matches status, requester, created_after, and created_before when one of its Jobs matches all of them.", "format": "date-time", "type": "string" } }, { "in": "query", "name": "created_before", "schema": { "description": "ISO 8601 time. The Job was created at or before it. A fork chain matches status, requester, created_after, and created_before when one of its Jobs matches all of them.", "format": "date-time", "type": "string" } }, { "in": "query", "name": "favorited", "schema": { "default": false, "description": "true lists only the chains whose newest Job the caller favorited.", "type": "boolean" } }, { "in": "query", "name": "after", "schema": { "description": "Opaque cursor returned as next_cursor.", "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 50, "description": "Fork chains per page, ordered by their newest Job. A fork chain is an original Job with its forks, such as fix reviews. The page lists every Job of each chain, newest first.", "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobPage" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "List audits and their fork chains" } }, "/jobs/shared-with-me": { "get": { "parameters": [ { "in": "query", "name": "after", "schema": { "description": "Opaque cursor returned as next_cursor.", "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobPage" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "List audits shared with you" } }, "/jobs/{job_id}": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobView" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Read an audit with findings and comments" }, "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ] }, "/jobs/{job_id}/account-shares": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/AccountShareView" }, "type": "array" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "List direct shares", "x-minimum-role": "member" }, "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAccountShare" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountShareView" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Request body is not application/json" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Share an audit with an Account", "x-minimum-role": "member" } }, "/jobs/{job_id}/account-shares/{account_id}": { "delete": { "responses": { "204": { "description": "Removed" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Revoke a direct share", "x-minimum-role": "member" }, "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "account_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ] }, "/jobs/{job_id}/artifacts": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/StoredArtifact" }, "type": "array" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Read findings and comments" }, "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePlatformArtifact" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoredArtifact" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Request body is not application/json" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Add a comment or response status", "x-minimum-role": "member" } }, "/jobs/{job_id}/cancellation": { "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelJob" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Request body is not application/json" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Request cancellation", "x-minimum-role": "member" } }, "/jobs/{job_id}/events": { "get": { "parameters": [ { "in": "query", "name": "after", "schema": { "description": "Opaque cursor returned as next_cursor.", "minimum": 0, "type": "integer" } }, { "in": "query", "name": "limit", "schema": { "default": 100, "maximum": 1000, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EventPage" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Read the audit timeline" }, "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ] }, "/jobs/{job_id}/pause": { "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PauseJob" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Request body is not application/json" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Pause an audit", "x-minimum-role": "member" } }, "/jobs/{job_id}/public-shares": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ShareView" }, "type": "array" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "List public share links", "x-minimum-role": "member" }, "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShare" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssuedShare" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Request body is not application/json" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create a public share link", "x-minimum-role": "member" } }, "/jobs/{job_id}/public-shares/{share_id}": { "delete": { "responses": { "204": { "description": "Revoked" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Revoke a public share link", "x-minimum-role": "member" }, "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "share_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ] }, "/jobs/{job_id}/resume": { "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "post": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Resume an audit", "x-minimum-role": "member" } }, "/jobs/{job_id}/source-file": { "parameters": [ { "in": "path", "name": "job_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceFileRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SourceFile" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Request body is not application/json" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Read a source or finding PoC file" } }, "/workspaces": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Workspace" }, "type": "array" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "List accessible workspaces" } }, "/workspaces/{workspace_id}": { "delete": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workspace" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Archive a workspace", "x-minimum-role": "admin" }, "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ] }, "/workspaces/{workspace_id}/billing": { "get": { "parameters": [ { "in": "query", "name": "after", "schema": { "description": "Opaque cursor returned as next_cursor.", "type": "string" } }, { "in": "query", "name": "limit", "schema": { "default": 50, "maximum": 200, "minimum": 1, "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BillingView" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Read workspace billing", "x-minimum-role": "admin" }, "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ] }, "/workspaces/{workspace_id}/context-files": { "get": { "parameters": [ { "in": "query", "name": "source_url", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ContextFile" }, "type": "array" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "List context files", "x-minimum-role": "member" }, "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "post": { "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "format": "binary", "type": "string" } }, "required": [ "file" ], "type": "object" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContextFile" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Upload a context file", "x-minimum-role": "member" } }, "/workspaces/{workspace_id}/funded-workspaces": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/FundedWorkspace" }, "type": "array" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "List funded workspaces", "x-minimum-role": "admin" }, "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFundedWorkspace" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workspace" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Request body is not application/json" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Create a funded workspace", "x-minimum-role": "admin" } }, "/workspaces/{workspace_id}/funded-workspaces/{team_workspace_id}": { "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "team_workspace_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "put": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFundedWorkspace" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundedWorkspace" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Request body is not application/json" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Adjust a funded workspace's credits", "x-minimum-role": "admin" } }, "/workspaces/{workspace_id}/funding-history": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/FundingChange" }, "type": "array" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Read funding history", "x-minimum-role": "admin" }, "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ] }, "/workspaces/{workspace_id}/github/pull-request-repositories": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/PullRequestRepository" }, "type": "array" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "List pull request review settings", "x-minimum-role": "admin" }, "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ] }, "/workspaces/{workspace_id}/github/pull-request-repositories/{repository_id}": { "delete": { "responses": { "204": { "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Disable pull request reviews", "x-minimum-role": "admin" }, "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "repository_id", "required": true, "schema": { "minimum": 1, "type": "integer" } } ], "put": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PullRequestReviewSettings" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PullRequestRepository" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Request body is not application/json" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Set pull request review settings", "x-minimum-role": "admin" } }, "/workspaces/{workspace_id}/github/pull-request-reviews/{review_id}": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PullRequestReview" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Read a pull request review", "x-minimum-role": "member" }, "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "review_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ] }, "/workspaces/{workspace_id}/github/pull-request-reviews/{review_id}/jobs": { "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "review_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateJob" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobAdmission" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Request body is not application/json" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Start a pull request review audit", "x-minimum-role": "member" } }, "/workspaces/{workspace_id}/invitations": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Invitation" }, "type": "array" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "List workspace invitations", "x-minimum-role": "admin" }, "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInvitation" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invitation" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Request body is not application/json" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Invite a workspace member", "x-minimum-role": "viewer" } }, "/workspaces/{workspace_id}/invitations/{invitation_id}": { "delete": { "responses": { "204": { "description": "Revoked" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Revoke an invitation", "x-minimum-role": "admin" }, "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "invitation_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ] }, "/workspaces/{workspace_id}/jobs": { "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateJob" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobAdmission" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Request body is not application/json" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Start an audit or fork a completed audit", "x-minimum-role": "member" } }, "/workspaces/{workspace_id}/jobs/quote": { "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "post": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateJob" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobQuote" } } }, "description": "Price of the Job; no Job is created and no credits move" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Request body is not application/json" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Quote an audit without starting it", "x-minimum-role": "viewer" } }, "/workspaces/{workspace_id}/members": { "get": { "responses": { "200": { "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/Member" }, "type": "array" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "List workspace members", "x-minimum-role": "admin" }, "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ] }, "/workspaces/{workspace_id}/members/{account_id}": { "delete": { "responses": { "204": { "description": "Removed" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Remove a member", "x-minimum-role": "admin" }, "parameters": [ { "in": "path", "name": "workspace_id", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "in": "path", "name": "account_id", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "put": { "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMember" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Member" } } }, "description": "Success" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials are missing or invalid" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Credentials lack access" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Not found" }, "415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Request body is not application/json" }, "422": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Invalid request" }, "429": { "$ref": "#/components/responses/TooManyRequests" }, "503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Database unavailable" }, "default": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "description": "Other error" } }, "security": [ { "bearerAuth": [] } ], "summary": "Change a member's role", "x-minimum-role": "admin" } } }, "security": [ { "bearerAuth": [] } ], "servers": [ { "url": "https://app.zerocool.ai/api" } ] }