openapi: 3.0.3
info:
    title: CircleCI API V3
    version: "3.0"
    description: |
        CircleCI's V3 API. Every route is served under `/api/v3` on `https://circleci.com`.

        No standard is implemented. V3 takes the ideas that work from established API designs and
        combines them into one coherent whole, but it is not JSON:API, not `problem+json`, and not HAL.
        Familiar names like `data`, `attributes`, `source.pointer` and `filter[...]` carry no behaviour
        from those specs. Take everything from this document, and do not use a standard-conformant client
        library.

        ## Conventions

        ### Auth

        `Authorization: Bearer <token>`. A token in a query parameter is rejected.

        ### Ids

        Ids are UUIDs, never slugs or names. Some collections resolve a slug via `filter[slug]`.

        ### One resource

        `{"data": {"id", "attributes", "references"}}`. Each entry in `references` is an `id`, or an array
        of them, sometimes carrying a nested `attributes` object of denormalised fields from the referenced
        resource. Read the operation's schema for which fields those are, and fetch the resource itself for
        anything not listed - there is no way to request more inline.

        ### A collection

        `{"data": [...], "page": {"next", "prev"}}`. `page.next` and `page.prev` are opaque cursor values,
        not URLs - send one back as `page[cursor]`, unmodified, and stop when `page.next` is `null`.
        `page[limit]` bounds are per-operation, and out of range is a 400, not a clamp.

        ### Scoping

        Scoping uses `filter[...]`. Most list operations require a scope filter such as `filter[org_id]` or
        `filter[project_id]` and return 400 without it, so read the operation's parameters.

        ### Methods

        `GET` reads, `POST` creates and performs named actions and partial updates, `PUT` replaces in full,
        `DELETE` removes. There is no `PATCH`.

        ### Retrying

        `GET`, `PUT` and `DELETE` are idempotent. V3 aims for idempotent `POST` wherever an operation
        allows it, but never assume a given `POST` is replayable: retrying one that timed out can create a
        second resource or fire an action twice. Retry a `POST` only if its own description says it is
        idempotent - otherwise re-read the collection to find out whether the first attempt landed.

        ### Destructive operations

        `DELETE`, and `POST` actions such as `cancel`, `delete`, `revoke` and `purge`, take effect
        immediately and normally cannot be undone. Treat them as irreversible: no operation here reverses
        another, and there is no dry-run mode. Where recovery is possible at all it is a support matter,
        not an API call.

        ### Errors

        Errors return a single `error` object, never an `errors` array:
        `{"error": {"type", "id", "title", "detail", "source"}}`. Branch on the status code; every member
        is optional. `error.type`, where present, separates causes within one status and is a bare token,
        not a URI. Never branch on `title` or `detail`. Quote `error.id` in support requests. Invalid input
        is always 400, never 422.

        ### Rate limits

        On 429, wait the `Retry-After` seconds, then back off exponentially. Responses carry
        `RateLimit-Policy` and `RateLimit`, the policy and the current state against it
        (IETF draft-ietf-httpapi-ratelimit-headers). Limits are per route and are not published: read the
        headers rather than assuming a figure.

        ### Caching

        Responses carry an `ETag` and a `Cache-Control` directive. Where a response has an `ETag`, send it
        back as `If-None-Match` to make the request conditional and get a 304 when nothing has changed.

        ### Deprecation

        A deprecated operation is marked `deprecated: true` and its responses carry `Deprecation`, whose
        value is `true` (RFC 9745), `Sunset`, the HTTP-date when the endpoint will be removed (RFC 8594),
        and `Link` with `rel="deprecation"`, pointing at the migration documentation (RFC 8288). Migrate
        before the `Sunset` date. A removed route returns 410, permanently.

        ### Additions

        Response fields are added without a version change. Ignore members you do not recognise rather
        than failing to parse.
servers:
    - url: https://circleci.com
security:
    - bearer_token: []
tags:
    - name: Analysis
      description: Credit spend aggregated by job, workflow or pipeline.
    - name: Catalog
      description: Marketplace catalog of available products and add-ons.
    - name: Configs
      description: Configuration compilation and validation.
    - name: Context Restrictions
      description: Restrictions that limit which projects, groups, or expressions may use a context.
    - name: Contexts
      description: Secret contexts that provide environment variables to jobs at runtime.
    - name: Deploy Components
      description: Release tracker components representing deployable units.
    - name: Deploy Config Suggestions
      description: Async requests to validate a CircleCI config and generate a suggested deploy config.
    - name: Deploy Deployments
      description: A deployment is one attempt to move a deploy component to a target version in an environment. Read in the scope of an organization via filter[org_id].
    - name: Deploy Diff Summaries
      description: Async requests to generate a human-readable summary of a code diff.
    - name: Deploy Environments
      description: Release tracker environments for deployment management.
    - name: Deploy Settings
      description: Per-project deploy configuration — the pipeline definitions run to deploy and to roll back. A singleton per project rather than an independently addressable resource.
    - name: Jobs
      description: Individual units of work within a workflow. Each job runs in its own execution environment and produces artifacts, test results, and logs.
    - name: Metric
      description: Time-bucketed count metrics (test result counts and test flake counts) over a time window.
    - name: Namespaces
      description: Scoping containers that group orbs under an organization. An orb's full name is namespace/orb-name.
    - name: Notification Channel Configs
      description: Per-user and per-project notification channel configuration — the email address or Slack channel a notification is delivered to.
    - name: Notification Integrations
      description: Currently Slack workspace integrations for an organization. Manage the connection used to deliver CircleCI notifications.
    - name: Notification Links
      description: Links between a CircleCI user and an external identity on a third-party connection (e.g. a Slack user). Used to deliver notifications, enable interactivity, and tag authors on that identity. Keyed by user, connection type, and external scope; not UUID-addressable.
    - name: Notification Preferences
      description: Per-user and per-project notification preference matrix. Read the matrix or bulk-toggle entries; scoped via filter[scope]=user|project.
    - name: Orb Categories
      description: Taxonomy labels for organizing and discovering orbs in the registry.
    - name: Orb Packages
      description: Reusable configuration packages published to the orb registry. Each orb belongs to a namespace and has one or more versioned releases.
    - name: Orb Versions
      description: Individual published releases of an orb, identified by semantic version. Each version contains the orb's source configuration.
    - name: Orgs
      description: Organizations are the top-level account entity. All projects, pipelines, and billing belong to an org.
    - name: Pipelines
      description: Pipeline definitions describe how to build, test, and deploy a project.
    - name: Projects
      description: Projects represent a source code repository connected to CircleCI. A project typically contains pipelines, environment variables, and settings.
    - name: Provider Branches
      description: VCS provider branches available to a project.
    - name: Provider Connections
      description: Connections between an organization and a VCS provider. Setup returns where to send the user; nothing is connected until they finish at the provider.
    - name: Provider Repositories
      description: Repositories an organization's provider installation can reach, as the calling user sees them. Scoped via filter[org_id] and filter[provider]; cursor-paged.
    - name: Runner Agents
      description: Self-hosted runner agents connected to a resource class. Read-only, scoped via filter[resource_class].
    - name: Runner Resource Classes
      description: Self-hosted runner resource classes — the pool identifier agents register against and jobs request work from.
    - name: Runner Tokens
      description: Authentication tokens for self-hosted runners.
    - name: Runs
      description: Runs record each trigger firing and group the workflows they produce. A run carries VCS context, parameter overrides, and pre-workflow errors.
    - name: Sidecar Commands
      description: Commands sent to a sidecar instance for execution.
    - name: Sidecar Instances
      description: Lightweight microVM environments that mirror a project's stack for inner-loop validation.
    - name: Sidecar Snapshots
      description: Point-in-time snapshots of a sidecar instance's filesystem and state.
    - name: Signing Certificates
      description: Apple code-signing certificates used to sign iOS builds.
    - name: Signing Configs
      description: iOS signing configurations pairing a certificate with provisioning profiles.
    - name: Tool Releases
      description: Released versions of the tools CircleCI distributes, such as circleci-cli and chunk-cli. Requires filter[tool], whose values are the tools' GitHub repository names, and returns that tool's latest release.
    - name: Triggers
      description: 'A trigger defines what causes a pipeline to run: a VCS event, a custom webhook, or a cron schedule.'
    - name: Usage
      description: Usage and billing data exports.
    - name: Users
      description: Authenticated identities (human or machine). Use ?filter[user_id]=me to resolve the authenticated identity.
    - name: Workflows
      description: Workflows organise jobs into a dependency graph. A run may produce multiple workflows that execute in parallel or sequence.
paths:
    /api/v3/analysis/charges:
        post:
            operationId: post-analysis-charges
            tags:
                - Analysis
            summary: Returns entities ranked by what they were charged.
            description: |-
                EXPERIMENTAL — This endpoint is experimental and may change without notice. Field names, request and response shapes, and pagination semantics are not yet stable. Do not depend on this endpoint in production clients.

                Returns a paginated list of charge totals scoped to one or more projects within a time window. The required analysis field selects what charges are grouped by: charge.job, charge.workflow or charge.pipeline.

                Each result is one entity name within one project, carrying the credits it was charged, the number of runs those credits are spread across, and the credits per run. A run is one instance of the entity: charge.job counts jobs, charge.workflow counts workflows, charge.pipeline counts pipelines.

                Other dimensions of a charge are filters rather than groupings, so slice by them through filter: actor.id, actor.external_slug, resource.class and charge.type, alongside job, workflow and pipeline values.

                The optional order_by field accepts an expression of the form  [asc|desc]. The direction is optional and falls back to a per-field default. When order_by is omitted or empty, results are sorted by credits desc. Supported fields and their default directions: credits (desc), runs (desc), credits_per_run (desc), name (asc).
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                analysis:
                                    type: string
                                filter:
                                    type: string
                                order_by:
                                    type: string
                                page:
                                    type: object
                                    properties:
                                        cursor:
                                            type: string
                                        limit:
                                            type: integer
                                    required:
                                        - cursor
                                        - limit
                                scope:
                                    type: object
                                    properties:
                                        from:
                                            type: string
                                            format: date-time
                                        project_ids:
                                            type: array
                                            items:
                                                type: string
                                                format: uuid
                                        to:
                                            type: string
                                            format: date-time
                                    required:
                                        - from
                                        - project_ids
                                        - to
                            required:
                                - analysis
                                - filter
                                - order_by
                                - page
                                - scope
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        credits:
                                                            type: integer
                                                        credits_per_run:
                                                            type: number
                                                        name:
                                                            type: string
                                                        runs:
                                                            type: integer
                                                    required:
                                                        - credits
                                                        - credits_per_run
                                                        - name
                                                        - runs
                                                id:
                                                    type: string
                                                    format: uuid
                                                references:
                                                    type: object
                                                    properties:
                                                        project:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                    required:
                                                        - project
                                            required:
                                                - attributes
                                                - id
                                                - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/analysis/jobs:
        post:
            operationId: post-analysis-jobs
            tags:
                - Analysis
            summary: Returns aggregated job results across runs.
            description: |-
                EXPERIMENTAL — This endpoint is experimental and may change without notice. Field names, request and response shapes, and pagination semantics are not yet stable. Do not depend on this endpoint in production clients.

                Returns a paginated list of aggregated job results scoped to one or more projects within a time window. Each result represents a unique job (identified by project + workflow + job name) and includes per-job duration quantiles, success rate, and distinct test counts across the window.

                The optional order_by field accepts an expression of the form  [asc|desc]. The direction is optional and falls back to a per-field default. When order_by is omitted or empty, results are sorted by name asc. Supported fields and their default directions: name (asc), workflow_name (asc), duration (desc), test_count (desc), flaky_test_count (desc), success_rate (desc).
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                filter:
                                    type: string
                                order_by:
                                    type: string
                                page:
                                    type: object
                                    properties:
                                        cursor:
                                            type: string
                                        limit:
                                            type: integer
                                    required:
                                        - cursor
                                        - limit
                                scope:
                                    type: object
                                    properties:
                                        from:
                                            type: string
                                            format: date-time
                                        project_ids:
                                            type: array
                                            items:
                                                type: string
                                                format: uuid
                                        to:
                                            type: string
                                            format: date-time
                                    required:
                                        - from
                                        - project_ids
                                        - to
                            required:
                                - filter
                                - order_by
                                - page
                                - scope
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        duration:
                                                            type: object
                                                            properties:
                                                                avg_ms:
                                                                    type: integer
                                                                p50_ms:
                                                                    type: integer
                                                                p95_ms:
                                                                    type: integer
                                                            required:
                                                                - avg_ms
                                                                - p50_ms
                                                                - p95_ms
                                                        flaky_test_count:
                                                            type: integer
                                                        name:
                                                            type: string
                                                        success_rate:
                                                            type: number
                                                        test_count:
                                                            type: integer
                                                        workflow_name:
                                                            type: string
                                                    required:
                                                        - duration
                                                        - flaky_test_count
                                                        - name
                                                        - success_rate
                                                        - test_count
                                                        - workflow_name
                                                id:
                                                    type: string
                                                    format: uuid
                                                references:
                                                    type: object
                                                    properties:
                                                        project:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                    required:
                                                        - project
                                            required:
                                                - attributes
                                                - id
                                                - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/analysis/tests:
        post:
            operationId: post-analysis-tests
            tags:
                - Analysis
            summary: Returns aggregated test results across runs.
            description: |-
                EXPERIMENTAL — This endpoint is experimental and may change without notice. Field names, request and response shapes, and pagination semantics are not yet stable. Do not depend on this endpoint in production clients.

                Returns a paginated list of aggregated test results scoped to one or more projects within a time window. Each result represents a unique test (identified by project + workflow + job + classname + file + name) and includes per-test success rate and average duration over the window.

                total_count is the number of non-skipped executions of the test in the window. flaky_count is the number of those executions that failed or errored within a pipeline where the same test also passed, matching the test_flake.pipeline metric. Skipped executions are excluded from every attribute, so a test that only ever skipped in the window is omitted.

                The optional order_by field accepts an expression of the form  [asc|desc]. The direction is optional and falls back to a per-field default. When order_by is omitted or empty, results are sorted by name asc. Supported fields and their default directions: name (asc), job_name (asc), duration (desc), flaky_count (desc), success_rate (desc).
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                filter:
                                    type: string
                                order_by:
                                    type: string
                                page:
                                    type: object
                                    properties:
                                        cursor:
                                            type: string
                                        limit:
                                            type: integer
                                    required:
                                        - cursor
                                        - limit
                                scope:
                                    type: object
                                    properties:
                                        from:
                                            type: string
                                            format: date-time
                                        project_ids:
                                            type: array
                                            items:
                                                type: string
                                                format: uuid
                                        to:
                                            type: string
                                            format: date-time
                                    required:
                                        - from
                                        - project_ids
                                        - to
                            required:
                                - filter
                                - order_by
                                - page
                                - scope
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        classname:
                                                            type: string
                                                        duration:
                                                            type: object
                                                            properties:
                                                                avg_ms:
                                                                    type: integer
                                                            required:
                                                                - avg_ms
                                                        file:
                                                            type: string
                                                        flaky_count:
                                                            type: integer
                                                        job_name:
                                                            type: string
                                                        name:
                                                            type: string
                                                        success_rate:
                                                            type: number
                                                        total_count:
                                                            type: integer
                                                        workflow_name:
                                                            type: string
                                                    required:
                                                        - classname
                                                        - duration
                                                        - file
                                                        - flaky_count
                                                        - job_name
                                                        - name
                                                        - success_rate
                                                        - total_count
                                                        - workflow_name
                                                id:
                                                    type: string
                                                    format: uuid
                                                references:
                                                    type: object
                                                    properties:
                                                        project:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                    required:
                                                        - project
                                            required:
                                                - attributes
                                                - id
                                                - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/analysis/usage:
        post:
            operationId: post-analysis-usage
            tags:
                - Analysis
            summary: Returns entities ranked by the resources they consumed.
            description: |-
                EXPERIMENTAL — This endpoint is experimental and may change without notice. Field names, request and response shapes, and pagination semantics are not yet stable. Do not depend on this endpoint in production clients.

                Returns a paginated list of resource usage scoped to one or more projects within a time window, which selects the jobs that completed inside it. The required analysis field picks the granularity: usage.job, usage.workflow or usage.pipeline.

                Each result is one entity name within one project. avg_cpu_used and avg_memory_bytes are means over that entity's samples, so they weight by run duration; peak_cpu_used and peak_memory_bytes are the largest single sample, not a concurrent total. cpu_utilization and ram_utilization are those means over what was allocated, where 1 is fully consumed and a low value means over-provisioned. network_bytes_received and network_bytes_transmitted are totals across runs. runs counts the entity's instances — jobs, workflows or pipelines per the granularity.

                A pipeline is named only by its configuration, so usage.pipeline reports pipelines that carry no name together under an empty name.

                Other dimensions are filters rather than groupings, so slice by them through filter: resource.class, resource.executor, resource.cpu (cores), resource.ram (mebibytes, unlike the *_memory_bytes attributes), parallel_execution.number, and job, workflow and pipeline values.

                The optional order_by takes  [asc|desc], defaulting to peak_memory_bytes desc. Supported fields and their default directions: peak_memory_bytes (desc), avg_memory_bytes (desc), peak_cpu_used (desc), avg_cpu_used (desc), cpu_utilization (asc), ram_utilization (asc), network_bytes_received (desc), network_bytes_transmitted (desc), runs (desc), name (asc). The utilizations default ascending because the least utilized entities are the over-provisioned ones.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                analysis:
                                    type: string
                                filter:
                                    type: string
                                order_by:
                                    type: string
                                page:
                                    type: object
                                    properties:
                                        cursor:
                                            type: string
                                        limit:
                                            type: integer
                                    required:
                                        - cursor
                                        - limit
                                scope:
                                    type: object
                                    properties:
                                        from:
                                            type: string
                                            format: date-time
                                        project_ids:
                                            type: array
                                            items:
                                                type: string
                                                format: uuid
                                        to:
                                            type: string
                                            format: date-time
                                    required:
                                        - from
                                        - project_ids
                                        - to
                            required:
                                - analysis
                                - filter
                                - order_by
                                - page
                                - scope
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        avg_cpu_used:
                                                            type: number
                                                        avg_memory_bytes:
                                                            type: number
                                                        cpu_utilization:
                                                            type: number
                                                        name:
                                                            type: string
                                                        network_bytes_received:
                                                            type: integer
                                                        network_bytes_transmitted:
                                                            type: integer
                                                        peak_cpu_used:
                                                            type: number
                                                        peak_memory_bytes:
                                                            type: integer
                                                        ram_utilization:
                                                            type: number
                                                        runs:
                                                            type: integer
                                                    required:
                                                        - avg_cpu_used
                                                        - avg_memory_bytes
                                                        - cpu_utilization
                                                        - name
                                                        - network_bytes_received
                                                        - network_bytes_transmitted
                                                        - peak_cpu_used
                                                        - peak_memory_bytes
                                                        - ram_utilization
                                                        - runs
                                                id:
                                                    type: string
                                                    format: uuid
                                                references:
                                                    type: object
                                                    properties:
                                                        project:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                    required:
                                                        - project
                                            required:
                                                - attributes
                                                - id
                                                - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/catalog/offerings:
        get:
            operationId: get-catalog-offerings
            tags:
                - Catalog
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    deprecated:
                                                        type: string
                                                    linux:
                                                        type: string
                                                    macos:
                                                        type: string
                                                    windows:
                                                        type: string
                                                required:
                                                    - deprecated
                                                    - linux
                                                    - macos
                                                    - windows
                                        required:
                                            - attributes
                                required:
                                    - data
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/configs/compile:
        post:
            operationId: post-configs-compile
            tags:
                - Configs
            summary: Compiles the supplied pipeline config, expanding orbs and resolving parameters.
            description: A config that fails to compile is reported as outcome "failed" with the reasons in meta.messages - still HTTP 200, since the request itself succeeded. The error envelope is reserved for request-level failures (malformed body, bad org, unauthorized).
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                config:
                                                    type: string
                                                pipeline_parameters:
                                                    type: object
                                                    additionalProperties: {}
                                                    nullable: true
                                                pipeline_values:
                                                    type: object
                                                    additionalProperties: {}
                                                    nullable: true
                                                should_preview_next:
                                                    type: boolean
                                                    nullable: true
                                            required:
                                                - config
                                        references:
                                            type: object
                                            properties:
                                                org:
                                                    type: object
                                                    properties:
                                                        id:
                                                            type: string
                                                            format: uuid
                                                    required:
                                                        - id
                                                    nullable: true
                                    required:
                                        - attributes
                                        - references
                            required:
                                - data
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    compiled_config:
                                                        type: string
                                                        nullable: true
                                                    outcome:
                                                        type: string
                                                    phase:
                                                        type: string
                                                required:
                                                    - outcome
                                                    - phase
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - attributes
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/context-restrictions:
        get:
            operationId: get-context-restrictions
            tags:
                - Context Restrictions
            summary: Lists the restrictions applied to a context.
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        created_at:
                                                            type: string
                                                            format: date-time
                                                        match_pattern:
                                                            type: string
                                                        restriction_type:
                                                            type: string
                                                    required:
                                                        - created_at
                                                        - match_pattern
                                                        - restriction_type
                                                id:
                                                    type: string
                                                    format: uuid
                                                references:
                                                    type: object
                                                    properties:
                                                        context:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                    required:
                                                        - context
                                            required:
                                                - attributes
                                                - id
                                                - references
                                required:
                                    - data
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        post:
            operationId: post-context-restrictions
            tags:
                - Context Restrictions
            summary: Creates a restriction for the context referenced in the request body.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                match_pattern:
                                                    type: string
                                                restriction_type:
                                                    type: string
                                            required:
                                                - match_pattern
                                                - restriction_type
                                        references:
                                            type: object
                                            properties:
                                                context:
                                                    type: object
                                                    properties:
                                                        attributes:
                                                            type: string
                                                            nullable: true
                                                        id:
                                                            type: string
                                                            format: uuid
                                                        rel:
                                                            type: string
                                                            nullable: true
                                                    required:
                                                        - id
                                            required:
                                                - context
                                    required:
                                        - attributes
                                        - references
                            required:
                                - data
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                    match_pattern:
                                                        type: string
                                                    restriction_type:
                                                        type: string
                                                required:
                                                    - created_at
                                                    - match_pattern
                                                    - restriction_type
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    context:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - context
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Invalid restriction type.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/context-restrictions/{id}:
        delete:
            operationId: delete-context-restrictions-by-id
            tags:
                - Context Restrictions
            summary: Deletes a context restriction by id, scoped to the required context_id filter.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/contexts:
        get:
            operationId: get-contexts
            tags:
                - Contexts
            summary: Lists the contexts owned by an organization.
            parameters:
                - name: page[cursor]
                  in: query
                  description: Opaque cursor for the next or previous page. Send back the value of page.next or page.prev from a previous response on this operation, verbatim - it is a cursor value, not a URL, and must not be constructed or decoded. Omit for the first page.
                  schema:
                    type: string
                - name: page[limit]
                  in: query
                  description: Maximum items in one page. Out-of-range values are rejected with 400 rather than clamped.
                  schema:
                    type: integer
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        created_at:
                                                            type: string
                                                            format: date-time
                                                        name:
                                                            type: string
                                                    required:
                                                        - created_at
                                                        - name
                                                id:
                                                    type: string
                                                    format: uuid
                                                references:
                                                    type: object
                                                    properties:
                                                        groups:
                                                            type: array
                                                            items:
                                                                type: object
                                                                properties:
                                                                    id:
                                                                        type: string
                                                                        format: uuid
                                                                required:
                                                                    - id
                                                            nullable: true
                                                        org:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                            nullable: true
                                            required:
                                                - attributes
                                                - id
                                                - references
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        post:
            operationId: post-contexts
            tags:
                - Contexts
            summary: Creates a context owned by an organization.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                name:
                                                    type: string
                                            required:
                                                - name
                                        references:
                                            type: object
                                            properties:
                                                org:
                                                    type: object
                                                    properties:
                                                        attributes:
                                                            type: string
                                                            nullable: true
                                                        id:
                                                            type: string
                                                            format: uuid
                                                        rel:
                                                            type: string
                                                            nullable: true
                                                    required:
                                                        - id
                                            required:
                                                - org
                                    required:
                                        - attributes
                                        - references
                            required:
                                - data
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                    name:
                                                        type: string
                                                required:
                                                    - created_at
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    groups:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                        nullable: true
                                                    org:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                        nullable: true
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/contexts/{id}:
        get:
            operationId: get-contexts-by-id
            tags:
                - Contexts
            summary: Returns a single context by id.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                    name:
                                                        type: string
                                                required:
                                                    - created_at
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    groups:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                        nullable: true
                                                    org:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                        nullable: true
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        delete:
            operationId: delete-contexts-by-id
            tags:
                - Contexts
            summary: Deletes a context by id.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/contexts/{id}/env-vars:
        get:
            operationId: get-contexts-by-id-env-vars
            tags:
                - Contexts
            summary: Lists the environment variables of a context.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
                - name: page[cursor]
                  in: query
                  description: Opaque cursor for the next or previous page. Send back the value of page.next or page.prev from a previous response on this operation, verbatim - it is a cursor value, not a URL, and must not be constructed or decoded. Omit for the first page.
                  schema:
                    type: string
                - name: page[limit]
                  in: query
                  description: Maximum items in one page. Out-of-range values are rejected with 400 rather than clamped.
                  schema:
                    type: integer
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        created_at:
                                                            type: string
                                                            format: date-time
                                                        name:
                                                            type: string
                                                        updated_at:
                                                            type: string
                                                            format: date-time
                                                    required:
                                                        - created_at
                                                        - name
                                                        - updated_at
                                                id:
                                                    type: string
                                                    format: uuid
                                                references:
                                                    type: object
                                                    properties:
                                                        context:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                    required:
                                                        - context
                                            required:
                                                - attributes
                                                - id
                                                - references
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        delete:
            operationId: delete-contexts-by-id-env-vars
            tags:
                - Contexts
            summary: Deletes an environment variable from a context by name.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
                - name: filter[name]
                  in: query
                  required: true
                  schema:
                    type: string
            responses:
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/contexts/{id}/env-vars/set:
        post:
            operationId: post-contexts-by-id-env-vars-set
            tags:
                - Contexts
            summary: Creates or updates an environment variable in a context.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                name:
                                    type: string
                                value:
                                    type: string
                            required:
                                - name
                                - value
            responses:
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/deploy/components:
        get:
            operationId: get-deploy-components
            tags:
                - Deploy Components
            summary: Returns an organization's deploy components, ordered by name.
            description: |-
                filter[org_id] is required — there is no unscoped listing of components across organizations. filter[project_id] optionally narrows the result to the components owned by one CircleCI project. Results are paginated with page[limit] and page[cursor].

                EXPERIMENTAL — this endpoint is experimental and may change without notice. Field names and response shapes are not yet stable, and the deploy API as a whole is still under review. Do not depend on it in production clients.
            parameters:
                - name: filter[org_id]
                  in: query
                  required: true
                  schema:
                    type: string
                    format: uuid
                - name: filter[project_id]
                  in: query
                  schema:
                    type: string
                    format: uuid
                - name: page[cursor]
                  in: query
                  description: Opaque cursor for the next or previous page. Send back the value of page.next or page.prev from a previous response on this operation, verbatim - it is a cursor value, not a URL, and must not be constructed or decoded. Omit for the first page.
                  schema:
                    type: string
                - name: page[limit]
                  in: query
                  description: Maximum items in one page. Out-of-range values are rejected with 400 rather than clamped.
                  schema:
                    type: integer
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - id
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                503:
                    description: Service unavailable.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
    /api/v3/deploy/components/{id}:
        get:
            operationId: get-deploy-components-by-id
            tags:
                - Deploy Components
            summary: Returns a single deploy component by id.
            description: |-
                A component the caller may not view is reported as not found, so the response does not reveal whether the id exists.

                EXPERIMENTAL — this endpoint is experimental and may change without notice. Field names and response shapes are not yet stable, and the deploy API as a whole is still under review. Do not depend on it in production clients.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    archived_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                    labels:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                key:
                                                                    type: string
                                                                value:
                                                                    type: string
                                                            required:
                                                                - key
                                                                - value
                                                    name:
                                                        type: string
                                                    release_count:
                                                        type: integer
                                                    updated_at:
                                                        type: string
                                                        format: date-time
                                                required:
                                                    - created_at
                                                    - labels
                                                    - name
                                                    - release_count
                                                    - updated_at
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    org:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    project:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - org
                                                    - project
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                503:
                    description: Service unavailable.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
    /api/v3/deploy/components/{id}/versions:
        get:
            operationId: get-deploy-components-by-id-versions
            tags:
                - Deploy Components
            summary: Returns a component's versions, most recently deployed first.
            description: |-
                Versions stay a sub-collection of their component because they have no identity of their own: a version is keyed by its name and the component instance it was deployed to, so collection items carry no id. filter[environment_id] narrows the result to one deploy environment. Results are paginated with page[limit] and page[cursor].

                EXPERIMENTAL — this endpoint is experimental and may change without notice. Field names and response shapes are not yet stable, and the deploy API as a whole is still under review. Do not depend on it in production clients.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
                - name: filter[environment_id]
                  in: query
                  schema:
                    type: string
                    format: uuid
                - name: page[cursor]
                  in: query
                  description: Opaque cursor for the next or previous page. Send back the value of page.next or page.prev from a previous response on this operation, verbatim - it is a cursor value, not a URL, and must not be constructed or decoded. Omit for the first page.
                  schema:
                    type: string
                - name: page[limit]
                  in: query
                  description: Maximum items in one page. Out-of-range values are rejected with 400 rather than clamped.
                  schema:
                    type: integer
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - id
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                503:
                    description: Service unavailable.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
    /api/v3/deploy/config-suggestions:
        post:
            operationId: post-deploy-config-suggestions
            tags:
                - Deploy Config Suggestions
            summary: Validates a CircleCI config and asynchronously
            description: generates a suggested config of the requested kind (deploy markers, deploy pipeline, or rollback pipeline). It stores the request and returns a 202 with a request ID; the client polls GET .../:id until phase=ended.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                config:
                                    type: string
                                is_auto_rollback_on_failure:
                                    type: boolean
                                    nullable: true
                                is_validation_enabled:
                                    type: boolean
                                    nullable: true
                                kind:
                                    type: string
                                org_id:
                                    type: string
                                project_id:
                                    type: string
                            required:
                                - config
                                - kind
                                - org_id
                                - project_id
            responses:
                202:
                    description: Accepted
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    config:
                                                        type: string
                                                        nullable: true
                                                    detail:
                                                        type: string
                                                        nullable: true
                                                    outcome:
                                                        type: string
                                                        nullable: true
                                                    phase:
                                                        type: string
                                                    summary:
                                                        type: string
                                                        nullable: true
                                                required:
                                                    - phase
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - attributes
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/deploy/config-suggestions/{id}:
        get:
            operationId: get-deploy-config-suggestions-by-id
            tags:
                - Deploy Config Suggestions
            summary: Returns the status of an async config suggestion request.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    config:
                                                        type: string
                                                        nullable: true
                                                    detail:
                                                        type: string
                                                        nullable: true
                                                    outcome:
                                                        type: string
                                                        nullable: true
                                                    phase:
                                                        type: string
                                                    summary:
                                                        type: string
                                                        nullable: true
                                                required:
                                                    - phase
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - attributes
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/deploy/deployments:
        get:
            operationId: get-deploy-deployments
            tags:
                - Deploy Deployments
            summary: Returns an organization's deployments, most recently created first.
            description: |-
                filter[org_id] is required — there is no unscoped listing of deployments across organizations, and the caller's permission to read that organization's deployments is what authorizes the request. The remaining filters narrow the result within the organization: by project, component, environment, the job that ran the deployment, a label, and a created-at window via filter[from] and filter[to].

                Results are paginated with page[limit] and page[cursor]; the cursor carries its own direction, so page.prev walks back towards newer deployments.

                EXPERIMENTAL — this endpoint is experimental and may change without notice. Field names and response shapes are not yet stable, and the deploy API as a whole is still under review. Do not depend on it in production clients.
            parameters:
                - name: filter[label]
                  in: query
                  schema:
                    type: string
                - name: filter[org_id]
                  in: query
                  required: true
                  schema:
                    type: string
                    format: uuid
                - name: page[cursor]
                  in: query
                  description: Opaque cursor for the next or previous page. Send back the value of page.next or page.prev from a previous response on this operation, verbatim - it is a cursor value, not a URL, and must not be constructed or decoded. Omit for the first page.
                  schema:
                    type: string
                - name: page[limit]
                  in: query
                  description: Maximum items in one page. Out-of-range values are rejected with 400 rather than clamped.
                  schema:
                    type: integer
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - id
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                503:
                    description: Service unavailable.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
    /api/v3/deploy/diff-summaries:
        post:
            operationId: post-deploy-diff-summaries
            tags:
                - Deploy Diff Summaries
            summary: Generates a summary of a diff asynchronously.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                diff:
                                    type: object
                                    properties:
                                        commit_messages:
                                            type: array
                                            items:
                                                type: string
                                        files:
                                            type: array
                                            items:
                                                type: object
                                                properties:
                                                    additions:
                                                        type: integer
                                                    deletions:
                                                        type: integer
                                                    filename:
                                                        type: string
                                                    patch:
                                                        type: string
                                                        nullable: true
                                                    status:
                                                        type: string
                                                required:
                                                    - additions
                                                    - deletions
                                                    - filename
                                                    - status
                                    required:
                                        - commit_messages
                                        - files
                                org_id:
                                    type: string
                                project_id:
                                    type: string
                            required:
                                - diff
                                - org_id
                                - project_id
            responses:
                202:
                    description: Accepted
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    config:
                                                        type: string
                                                        nullable: true
                                                    detail:
                                                        type: string
                                                        nullable: true
                                                    outcome:
                                                        type: string
                                                        nullable: true
                                                    phase:
                                                        type: string
                                                    summary:
                                                        type: string
                                                        nullable: true
                                                required:
                                                    - phase
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - attributes
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                413:
                    description: Request Entity Too Large
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/deploy/diff-summaries/{id}:
        get:
            operationId: get-deploy-diff-summaries-by-id
            tags:
                - Deploy Diff Summaries
            summary: Gets the status of an async diff summary request.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    config:
                                                        type: string
                                                        nullable: true
                                                    detail:
                                                        type: string
                                                        nullable: true
                                                    outcome:
                                                        type: string
                                                        nullable: true
                                                    phase:
                                                        type: string
                                                    summary:
                                                        type: string
                                                        nullable: true
                                                required:
                                                    - phase
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - attributes
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/deploy/environments:
        get:
            operationId: get-deploy-environments
            tags:
                - Deploy Environments
            summary: Returns an organization's deploy environments, ordered by name.
            description: |-
                filter[org_id] is required — there is no unscoped listing of environments across organizations. Results are paginated with page[limit] and page[cursor].

                EXPERIMENTAL — this endpoint is experimental and may change without notice. Field names and response shapes are not yet stable, and the deploy API as a whole is still under review. Do not depend on it in production clients.
            parameters:
                - name: filter[org_id]
                  in: query
                  required: true
                  schema:
                    type: string
                    format: uuid
                - name: page[cursor]
                  in: query
                  description: Opaque cursor for the next or previous page. Send back the value of page.next or page.prev from a previous response on this operation, verbatim - it is a cursor value, not a URL, and must not be constructed or decoded. Omit for the first page.
                  schema:
                    type: string
                - name: page[limit]
                  in: query
                  description: Maximum items in one page. Out-of-range values are rejected with 400 rather than clamped.
                  schema:
                    type: integer
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - id
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                503:
                    description: Service unavailable.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
    /api/v3/deploy/environments/{id}:
        get:
            operationId: get-deploy-environments-by-id
            tags:
                - Deploy Environments
            summary: Returns a single deploy environment by id.
            description: |-
                An environment the caller may not view is reported as not found, so the response does not reveal whether the id exists.

                EXPERIMENTAL — this endpoint is experimental and may change without notice. Field names and response shapes are not yet stable, and the deploy API as a whole is still under review. Do not depend on it in production clients.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                    description:
                                                        type: string
                                                        nullable: true
                                                    kind:
                                                        type: string
                                                    labels:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                key:
                                                                    type: string
                                                                value:
                                                                    type: string
                                                            required:
                                                                - key
                                                                - value
                                                    name:
                                                        type: string
                                                    updated_at:
                                                        type: string
                                                        format: date-time
                                                required:
                                                    - created_at
                                                    - kind
                                                    - labels
                                                    - name
                                                    - updated_at
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    org:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - org
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                503:
                    description: Service unavailable.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
    /api/v3/deploy/settings:
        get:
            operationId: get-deploy-settings
            tags:
                - Deploy Settings
            summary: Returns a project's deploy settings.
            description: |-
                Deploy settings are a singleton per project rather than an independently addressable resource, so they are selected with a required filter[project_id] instead of a path id, and the returned data.id is the project's own UUID.

                A project that has never had deploy settings saved reports empty settings rather than a 404, matching the V2 behaviour: not having configured a deploy pipeline is a normal state, not a missing resource. A project the caller may not view is reported as not found.

                EXPERIMENTAL — this endpoint is experimental and may change without notice. Field names and response shapes are not yet stable, and the deploy API as a whole is still under review. Do not depend on it in production clients.
            parameters:
                - name: filter[project_id]
                  in: query
                  required: true
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                    updated_at:
                                                        type: string
                                                        format: date-time
                                                required:
                                                    - created_at
                                                    - updated_at
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    pipelines:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                    project:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - pipelines
                                                    - project
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                503:
                    description: Service unavailable.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
    /api/v3/jobs:
        get:
            operationId: get-jobs
            tags:
                - Jobs
            summary: Lists the jobs in a workflow.
            parameters:
                - name: filter[workflow_id]
                  in: query
                  required: true
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        ended_at:
                                                            type: string
                                                            format: date-time
                                                            nullable: true
                                                        name:
                                                            type: string
                                                        number:
                                                            type: integer
                                                        outcome:
                                                            type: string
                                                            nullable: true
                                                        phase:
                                                            type: string
                                                        started_at:
                                                            type: string
                                                            format: date-time
                                                            nullable: true
                                                        type:
                                                            type: string
                                                    required:
                                                        - name
                                                        - number
                                                        - phase
                                                        - type
                                                id:
                                                    type: string
                                                    format: uuid
                                                references:
                                                    type: object
                                                    properties:
                                                        project:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                        workflow:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                    required:
                                                        - project
                                                        - workflow
                                            required:
                                                - attributes
                                                - id
                                                - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/jobs/{id}:
        get:
            operationId: get-jobs-by-id
            tags:
                - Jobs
            summary: Fetches a single job, including its steps and parallel executions.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    ended_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    name:
                                                        type: string
                                                    outcome:
                                                        type: string
                                                        nullable: true
                                                    parallel_executions:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                steps:
                                                                    type: array
                                                                    items:
                                                                        type: object
                                                                        properties:
                                                                            command:
                                                                                type: string
                                                                                nullable: true
                                                                            ended_at:
                                                                                type: string
                                                                                format: date-time
                                                                                nullable: true
                                                                            exit_code:
                                                                                type: integer
                                                                                nullable: true
                                                                            name:
                                                                                type: string
                                                                            num:
                                                                                type: integer
                                                                            outcome:
                                                                                type: string
                                                                                nullable: true
                                                                            phase:
                                                                                type: string
                                                                            started_at:
                                                                                type: string
                                                                                format: date-time
                                                                                nullable: true
                                                                            stderr_bytes:
                                                                                type: integer
                                                                                nullable: true
                                                                            stdout_bytes:
                                                                                type: integer
                                                                                nullable: true
                                                                            type:
                                                                                type: string
                                                                        required:
                                                                            - name
                                                                            - num
                                                                            - phase
                                                                            - type
                                                            required:
                                                                - steps
                                                        nullable: true
                                                    phase:
                                                        type: string
                                                    started_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    type:
                                                        type: string
                                                required:
                                                    - name
                                                    - phase
                                                    - type
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    pipeline:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    project:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    user:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                        nullable: true
                                                    workflow:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - pipeline
                                                    - project
                                                    - workflow
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/jobs/{id}/artifacts:
        get:
            operationId: get-jobs-by-id-artifacts
            tags:
                - Jobs
            summary: Lists the artifacts produced by a job's parallel executions.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        execution:
                                                            type: integer
                                                        path:
                                                            type: string
                                                        url:
                                                            type: string
                                                    required:
                                                        - execution
                                                        - path
                                                        - url
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - attributes
                                                - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/jobs/{id}/resource-usage:
        get:
            operationId: get-jobs-by-id-resource-usage
            tags:
                - Jobs
            summary: Returns a job's recorded resource usage per parallel execution.
            description: |-
                Each execution reports ordered CPU, memory and network samples taken interval_ms apart, alongside the resource class the job was dispatched to. Samples carry no timestamps: the first sample is the first collection tick after the execution started.

                Only Docker executions record samples, so machine and runner jobs return an empty parallel_executions list. Recordings expire after 90 days, and an execution that recorded nothing is absent from the list rather than empty, so a missing execution is not an execution that did not run.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    parallel_executions:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                cpu_cores:
                                                                    type: array
                                                                    items:
                                                                        type: number
                                                                execution:
                                                                    type: integer
                                                                interval_ms:
                                                                    type: integer
                                                                memory_bytes:
                                                                    type: array
                                                                    items:
                                                                        type: integer
                                                                network_rx_bytes:
                                                                    type: integer
                                                                network_tx_bytes:
                                                                    type: integer
                                                            required:
                                                                - cpu_cores
                                                                - execution
                                                                - interval_ms
                                                                - memory_bytes
                                                                - network_rx_bytes
                                                                - network_tx_bytes
                                                    resource_class:
                                                        type: object
                                                        properties:
                                                            cpu_count:
                                                                type: integer
                                                            memory_limit_bytes:
                                                                type: integer
                                                            name:
                                                                type: string
                                                        required:
                                                            - cpu_count
                                                            - memory_limit_bytes
                                                            - name
                                                        nullable: true
                                                required:
                                                    - parallel_executions
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - attributes
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/jobs/{id}/stderr:
        get:
            operationId: get-jobs-by-id-stderr
            tags:
                - Jobs
            summary: Returns the stderr of a job step for a given parallel execution.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
                - name: filter[execution]
                  in: query
                  required: true
                  schema:
                    type: integer
                - name: filter[step_num]
                  in: query
                  required: true
                  schema:
                    type: integer
            responses:
                204:
                    description: No Content
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/jobs/{id}/stdout:
        get:
            operationId: get-jobs-by-id-stdout
            tags:
                - Jobs
            summary: Returns the stdout of a job step for a given parallel execution.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
                - name: filter[execution]
                  in: query
                  required: true
                  schema:
                    type: integer
                - name: filter[step_num]
                  in: query
                  required: true
                  schema:
                    type: integer
            responses:
                204:
                    description: No Content
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/jobs/{id}/stdout/condensed:
        get:
            operationId: get-jobs-by-id-stdout-condensed
            tags:
                - Jobs
            summary: Returns a step's stdout condensed to its most error-relevant lines, suitable for AI-agent consumption.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
                - name: filter[execution]
                  in: query
                  required: true
                  schema:
                    type: integer
                - name: filter[step_num]
                  in: query
                  required: true
                  schema:
                    type: integer
            responses:
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/jobs/{id}/tests:
        get:
            operationId: get-jobs-by-id-tests
            tags:
                - Jobs
            summary: Returns a job's structured test results as JSON Lines.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                204:
                    description: No Content
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/metric/counts:
        post:
            operationId: post-metric-counts
            tags:
                - Metric
            summary: Returns time-bucketed counts for a named metric.
            description: |-
                EXPERIMENTAL — This endpoint is experimental and may change without notice. Field names, request and response shapes, and supported metrics are not yet stable. Do not depend on this endpoint in production clients.

                Returns count metrics (test result counts and test flake counts) over a time window, split into fixed-width buckets. Each bucket contains one or more groups when group_by dimensions are supplied. Each group's key is a positional array whose entries align 1:1 with the request's group_by expressions (so key[i] is the value for group_by[i]), and is null when no group_by is supplied.

                Buckets with no matching rows are omitted rather than zero-filled — including the single bucket of an interval=none request over an empty window, which returns an empty buckets array. Clients should treat an absent bucket as zero.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                filter:
                                    type: string
                                group_by:
                                    type: array
                                    items:
                                        type: string
                                interval:
                                    type: string
                                metric:
                                    type: string
                                scope:
                                    type: object
                                    properties:
                                        from:
                                            type: string
                                            format: date-time
                                        project_ids:
                                            type: array
                                            items:
                                                type: string
                                                format: uuid
                                        to:
                                            type: string
                                            format: date-time
                                    required:
                                        - from
                                        - project_ids
                                        - to
                            required:
                                - filter
                                - group_by
                                - interval
                                - metric
                                - scope
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    buckets:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                groups:
                                                                    type: array
                                                                    items:
                                                                        type: object
                                                                        properties:
                                                                            key:
                                                                                type: array
                                                                                items: {}
                                                                            metrics:
                                                                                type: object
                                                                                properties:
                                                                                    count:
                                                                                        type: integer
                                                                                required:
                                                                                    - count
                                                                        required:
                                                                            - key
                                                                            - metrics
                                                                is_truncated:
                                                                    type: boolean
                                                                start_at:
                                                                    type: string
                                                                    format: date-time
                                                            required:
                                                                - groups
                                                                - is_truncated
                                                                - start_at
                                                    group_by:
                                                        type: array
                                                        items:
                                                            type: string
                                                    interval_ms:
                                                        type: integer
                                                required:
                                                    - buckets
                                                    - group_by
                                                    - interval_ms
                                        required:
                                            - attributes
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/metric/distributions:
        post:
            operationId: post-metric-distributions
            tags:
                - Metric
            summary: Returns time-bucketed distribution metrics for a named metric.
            description: |-
                EXPERIMENTAL — This endpoint is experimental and may change without notice. Field names, request and response shapes, and supported metrics are not yet stable. Do not depend on this endpoint in production clients.

                Returns distribution metrics (e.g. test result duration percentiles) over a time window, split into fixed-width buckets. Each bucket contains one or more groups when group_by dimensions are supplied. Each group's key is a positional array whose entries align 1:1 with the request's group_by expressions (so key[i] is the value for group_by[i]), and is null when no group_by is supplied.

                Buckets with no matching rows are omitted rather than zero-filled — including the single bucket of an interval=none request over an empty window, which returns an empty buckets array. An absent bucket means no observations in that slice; do not invent zero averages or percentiles.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                filter:
                                    type: string
                                group_by:
                                    type: array
                                    items:
                                        type: string
                                interval:
                                    type: string
                                metric:
                                    type: string
                                scope:
                                    type: object
                                    properties:
                                        from:
                                            type: string
                                            format: date-time
                                        project_ids:
                                            type: array
                                            items:
                                                type: string
                                                format: uuid
                                        to:
                                            type: string
                                            format: date-time
                                    required:
                                        - from
                                        - project_ids
                                        - to
                            required:
                                - filter
                                - group_by
                                - interval
                                - metric
                                - scope
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    buckets:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                groups:
                                                                    type: array
                                                                    items:
                                                                        type: object
                                                                        properties:
                                                                            key:
                                                                                type: array
                                                                                items: {}
                                                                            metrics:
                                                                                type: object
                                                                                properties:
                                                                                    avg:
                                                                                        type: integer
                                                                                    count:
                                                                                        type: integer
                                                                                    p5:
                                                                                        type: integer
                                                                                    p50:
                                                                                        type: integer
                                                                                    p90:
                                                                                        type: integer
                                                                                    p95:
                                                                                        type: integer
                                                                                    p99:
                                                                                        type: integer
                                                                                    sum:
                                                                                        type: integer
                                                                                required:
                                                                                    - avg
                                                                                    - count
                                                                                    - p5
                                                                                    - p50
                                                                                    - p90
                                                                                    - p95
                                                                                    - p99
                                                                                    - sum
                                                                        required:
                                                                            - key
                                                                            - metrics
                                                                is_truncated:
                                                                    type: boolean
                                                                start_at:
                                                                    type: string
                                                                    format: date-time
                                                            required:
                                                                - groups
                                                                - is_truncated
                                                                - start_at
                                                    group_by:
                                                        type: array
                                                        items:
                                                            type: string
                                                    interval_ms:
                                                        type: integer
                                                required:
                                                    - buckets
                                                    - group_by
                                                    - interval_ms
                                        required:
                                            - attributes
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/namespaces:
        get:
            operationId: get-namespaces
            tags:
                - Namespaces
            summary: List namespaces.
            parameters:
                - name: filter[name]
                  in: query
                  required: true
                  schema:
                    type: string
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    name:
                                                        type: string
                                                required:
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - attributes
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        post:
            operationId: post-namespaces
            tags:
                - Namespaces
            summary: Create a new namespace.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                name:
                                    type: string
                                org_id:
                                    type: string
                                    format: uuid
                            required:
                                - name
                                - org_id
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    name:
                                                        type: string
                                                required:
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - attributes
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/namespaces/import:
        post:
            operationId: post-namespaces-import
            tags:
                - Namespaces
            summary: Import a namespace.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                name:
                                    type: string
                                org_id:
                                    type: string
                                    format: uuid
                            required:
                                - name
                                - org_id
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    name:
                                                        type: string
                                                required:
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - attributes
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/namespaces/{id}:
        get:
            operationId: get-namespaces-by-id
            tags:
                - Namespaces
            summary: Retrieve a single namespace by its ID.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    name:
                                                        type: string
                                                required:
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - attributes
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        delete:
            operationId: delete-namespaces-by-id
            tags:
                - Namespaces
            summary: Delete a namespace.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                204:
                    description: No Content
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/namespaces/{id}/rename:
        post:
            operationId: post-namespaces-by-id-rename
            tags:
                - Namespaces
            summary: Rename a namespace.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                name:
                                    type: string
                            required:
                                - name
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    name:
                                                        type: string
                                                required:
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - attributes
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/notification/channel-configs:
        get:
            operationId: get-notification-channel-configs
            tags:
                - Notification Channel Configs
            summary: Serves the V3 channel-config collection.
            description: filter[scope] selects user or project scope; project scope also requires filter[project_id] and filter[org_id].
            parameters:
                - name: filter[org_id]
                  in: query
                  required: true
                  schema:
                    type: string
                - name: filter[project_id]
                  in: query
                  required: true
                  schema:
                    type: string
                - name: filter[scope]
                  in: query
                  required: true
                  schema:
                    type: string
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - id
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Filter[scope] must be "user" or "project"
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        post:
            operationId: post-notification-channel-configs
            tags:
                - Notification Channel Configs
            summary: Creates (or replaces) a channel config.
            description: Scope comes from data.attributes.scope; user scope requires an org reference, project scope requires project + org references.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                channel_type:
                                                    type: string
                                                is_enabled:
                                                    type: boolean
                                                scope:
                                                    type: string
                                                target:
                                                    type: string
                                                    nullable: true
                                            required:
                                                - channel_type
                                                - is_enabled
                                                - scope
                                        references:
                                            type: object
                                            properties:
                                                org:
                                                    type: object
                                                    properties:
                                                        id:
                                                            type: string
                                                            format: uuid
                                                    required:
                                                        - id
                                                project:
                                                    type: object
                                                    properties:
                                                        id:
                                                            type: string
                                                            format: uuid
                                                    required:
                                                        - id
                                            required:
                                                - org
                                                - project
                                    required:
                                        - attributes
                                        - references
                            required:
                                - data
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    channel_name:
                                                        type: string
                                                        nullable: true
                                                    channel_type:
                                                        type: string
                                                    is_enabled:
                                                        type: boolean
                                                    target:
                                                        type: string
                                                        nullable: true
                                                required:
                                                    - channel_type
                                                    - is_enabled
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    org:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    project:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    user:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - org
                                                    - project
                                                    - user
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Invalid channel_type
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/notification/channel-configs/{id}:
        get:
            operationId: get-notification-channel-configs-by-id
            tags:
                - Notification Channel Configs
            summary: Returns a single channel config addressed by its row id.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    channel_name:
                                                        type: string
                                                        nullable: true
                                                    channel_type:
                                                        type: string
                                                    is_enabled:
                                                        type: boolean
                                                    target:
                                                        type: string
                                                        nullable: true
                                                required:
                                                    - channel_type
                                                    - is_enabled
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    org:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    project:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    user:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - org
                                                    - project
                                                    - user
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        delete:
            operationId: delete-notification-channel-configs-by-id
            tags:
                - Notification Channel Configs
            summary: Deletes the channel config addressed by id.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                400:
                    description: Bad request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/notification/channel-configs/{id}/update:
        post:
            operationId: post-notification-channel-configs-by-id-update
            tags:
                - Notification Channel Configs
            summary: Applies a partial update to the channel config.
            description: Only target and/or is_enabled may change; the config is addressed by id.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                is_enabled:
                                                    type: boolean
                                                    nullable: true
                                                target:
                                                    type: string
                                                    nullable: true
                                    required:
                                        - attributes
                            required:
                                - data
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    channel_name:
                                                        type: string
                                                        nullable: true
                                                    channel_type:
                                                        type: string
                                                    is_enabled:
                                                        type: boolean
                                                    target:
                                                        type: string
                                                        nullable: true
                                                required:
                                                    - channel_type
                                                    - is_enabled
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    org:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    project:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    user:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - org
                                                    - project
                                                    - user
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/notification/integrations:
        get:
            operationId: get-notification-integrations
            tags:
                - Notification Integrations
            summary: List notification integrations.
            parameters:
                - name: filter[org_id]
                  in: query
                  schema:
                    type: string
                - name: filter[type]
                  in: query
                  schema:
                    type: string
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - id
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Filter[org_id] must be a UUID
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/notification/integrations/{id}:
        get:
            operationId: get-notification-integrations-by-id
            tags:
                - Notification Integrations
            summary: Retrieve a single notification integration by its ID.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                    status:
                                                        type: string
                                                    team_id:
                                                        type: string
                                                    type:
                                                        type: string
                                                    updated_at:
                                                        type: string
                                                        format: date-time
                                                    workspace_name:
                                                        type: string
                                                required:
                                                    - created_at
                                                    - status
                                                    - team_id
                                                    - type
                                                    - updated_at
                                                    - workspace_name
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    org:
                                                        type: object
                                                        properties:
                                                            attributes:
                                                                type: object
                                                                properties:
                                                                    name:
                                                                        type: string
                                                                required:
                                                                    - name
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - attributes
                                                            - id
                                                required:
                                                    - org
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        delete:
            operationId: delete-notification-integrations-by-id
            tags:
                - Notification Integrations
            summary: Delete a notification integration.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                400:
                    description: Bad request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/notification/integrations/{id}/set-status:
        post:
            operationId: post-notification-integrations-by-id-set-status
            tags:
                - Notification Integrations
            summary: Set status.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                status:
                                                    type: string
                                            required:
                                                - status
                                    required:
                                        - attributes
                            required:
                                - data
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                    status:
                                                        type: string
                                                    team_id:
                                                        type: string
                                                    type:
                                                        type: string
                                                    updated_at:
                                                        type: string
                                                        format: date-time
                                                    workspace_name:
                                                        type: string
                                                required:
                                                    - created_at
                                                    - status
                                                    - team_id
                                                    - type
                                                    - updated_at
                                                    - workspace_name
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    org:
                                                        type: object
                                                        properties:
                                                            attributes:
                                                                type: object
                                                                properties:
                                                                    name:
                                                                        type: string
                                                                required:
                                                                    - name
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - attributes
                                                            - id
                                                required:
                                                    - org
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Status must be "active" or "disabled"
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/notification/links:
        get:
            operationId: get-notification-links
            tags:
                - Notification Links
            summary: Lists the authenticated caller's external identity links.
            description: |-
                EXPERIMENTAL — This endpoint is experimental and may change without notice. Field names, request and response shapes, and pagination semantics are not yet stable. Do not depend on this endpoint in production clients.

                filter[user_id] is required ("me" or the caller's own UUID). filter[connection_type] is optional (omitted lists all known connection types); filter[team_id] is optional and narrows results to a single external scope.
            parameters:
                - name: filter[connection_type]
                  in: query
                  schema:
                    type: string
                - name: filter[team_id]
                  in: query
                  schema:
                    type: string
                - name: filter[user_id]
                  in: query
                  required: true
                  schema:
                    type: string
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        connection_type:
                                                            type: string
                                                        display_name:
                                                            type: string
                                                        external_id:
                                                            type: string
                                                        external_scope_id:
                                                            type: string
                                                    required:
                                                        - connection_type
                                                        - display_name
                                                        - external_id
                                                        - external_scope_id
                                                id:
                                                    type: string
                                                    format: uuid
                                                references:
                                                    type: object
                                                    properties:
                                                        user:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                    required:
                                                        - user
                                            required:
                                                - attributes
                                                - id
                                                - references
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Filter[user_id] must be "me" or a user UUID
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        delete:
            operationId: delete-notification-links
            tags:
                - Notification Links
            summary: Removes a single external identity link.
            description: |-
                EXPERIMENTAL — This endpoint is experimental and may change without notice. Field names and request shape are not yet stable. Do not depend on this endpoint in production clients.

                filter[user_id] ("me" or the caller's own UUID), filter[connection_type], and filter[team_id] are all required — together they form the CIAM link key. Idempotent: returns 204 whether or not a matching link exists.
            parameters:
                - name: filter[connection_type]
                  in: query
                  required: true
                  schema:
                    type: string
                - name: filter[team_id]
                  in: query
                  required: true
                  schema:
                    type: string
                - name: filter[user_id]
                  in: query
                  required: true
                  schema:
                    type: string
            responses:
                400:
                    description: Unsupported connection_type
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/notification/preferences:
        get:
            operationId: get-notification-preferences
            tags:
                - Notification Preferences
            summary: Serves the V3 preference matrix.
            description: filter[scope] selects user or project scope; project scope also requires filter[project_id] and filter[org_id].
            parameters:
                - name: filter[org_id]
                  in: query
                  required: true
                  schema:
                    type: string
                - name: filter[project_id]
                  in: query
                  required: true
                  schema:
                    type: string
                - name: filter[scope]
                  in: query
                  required: true
                  schema:
                    type: string
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - id
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Filter[scope] must be "user" or "project"
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        post:
            operationId: post-notification-preferences
            tags:
                - Notification Preferences
            summary: Bulk-updates the changed subset of the matrix.
            description: It returns the refreshed matrix. Partial and non-idempotent, hence POST. Scope comes from data.attributes.scope; project scope also requires project + org references.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                scope:
                                                    type: string
                                                updates:
                                                    type: array
                                                    items:
                                                        type: object
                                                        properties:
                                                            is_enabled:
                                                                type: boolean
                                                            preference_id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - is_enabled
                                                            - preference_id
                                            required:
                                                - scope
                                                - updates
                                        references:
                                            type: object
                                            properties:
                                                org:
                                                    type: object
                                                    properties:
                                                        id:
                                                            type: string
                                                            format: uuid
                                                    required:
                                                        - id
                                                project:
                                                    type: object
                                                    properties:
                                                        id:
                                                            type: string
                                                            format: uuid
                                                    required:
                                                        - id
                                            required:
                                                - org
                                                - project
                                    required:
                                        - attributes
                                        - references
                            required:
                                - data
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - id
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/orb/categories:
        get:
            operationId: get-orb-categories
            tags:
                - Orb Categories
            summary: Returns all orb categories with pagination.
            parameters:
                - name: page[cursor]
                  in: query
                  description: Opaque cursor for the next or previous page. Send back the value of page.next or page.prev from a previous response on this operation, verbatim - it is a cursor value, not a URL, and must not be constructed or decoded. Omit for the first page.
                  schema:
                    type: string
                - name: page[limit]
                  in: query
                  description: Maximum items in one page. Out-of-range values are rejected with 400 rather than clamped.
                  schema:
                    type: integer
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        name:
                                                            type: string
                                                    required:
                                                        - name
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - attributes
                                                - id
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/orb/packages:
        get:
            operationId: get-orb-packages
            tags:
                - Orb Packages
            summary: Returns a list of packages limited by the given filter.
            parameters:
                - name: filter[certified]
                  in: query
                  schema:
                    type: boolean
                - name: filter[name]
                  in: query
                  schema:
                    type: string
                - name: filter[namespace_id]
                  in: query
                  schema:
                    type: string
                    format: uuid
                - name: filter[visibility]
                  in: query
                  schema:
                    type: string
                - name: page[cursor]
                  in: query
                  description: Opaque cursor for the next or previous page. Send back the value of page.next or page.prev from a previous response on this operation, verbatim - it is a cursor value, not a URL, and must not be constructed or decoded. Omit for the first page.
                  schema:
                    type: string
                - name: page[limit]
                  in: query
                  description: Maximum items in one page. Out-of-range values are rejected with 400 rather than clamped.
                  schema:
                    type: integer
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        is_listed:
                                                            type: boolean
                                                        is_private:
                                                            type: boolean
                                                        last_30_days_build_count:
                                                            type: integer
                                                        last_30_days_org_count:
                                                            type: integer
                                                        last_30_days_project_count:
                                                            type: integer
                                                        name:
                                                            type: string
                                                    required:
                                                        - is_listed
                                                        - is_private
                                                        - last_30_days_build_count
                                                        - last_30_days_org_count
                                                        - last_30_days_project_count
                                                        - name
                                                id:
                                                    type: string
                                                    format: uuid
                                                references:
                                                    type: object
                                                    properties:
                                                        namespace:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                        orb_categories:
                                                            type: array
                                                            items:
                                                                type: object
                                                                properties:
                                                                    attributes:
                                                                        type: object
                                                                        properties:
                                                                            name:
                                                                                type: string
                                                                        required:
                                                                            - name
                                                                    id:
                                                                        type: string
                                                                        format: uuid
                                                                required:
                                                                    - attributes
                                                                    - id
                                                            nullable: true
                                                        orb_versions:
                                                            type: array
                                                            items:
                                                                type: object
                                                                properties:
                                                                    attributes:
                                                                        type: object
                                                                        properties:
                                                                            created_at:
                                                                                type: string
                                                                                format: date-time
                                                                                nullable: true
                                                                            version:
                                                                                type: string
                                                                        required:
                                                                            - version
                                                                    id:
                                                                        type: string
                                                                        format: uuid
                                                                required:
                                                                    - attributes
                                                                    - id
                                                            nullable: true
                                                    required:
                                                        - namespace
                                            required:
                                                - attributes
                                                - id
                                                - references
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        post:
            operationId: post-orb-packages
            tags:
                - Orb Packages
            summary: Creates a new orb package in the given namespace.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                is_private:
                                                    type: boolean
                                                    nullable: true
                                                name:
                                                    type: string
                                            required:
                                                - name
                                        references:
                                            type: object
                                            properties:
                                                namespace:
                                                    type: object
                                                    properties:
                                                        id:
                                                            type: string
                                                            format: uuid
                                                    required:
                                                        - id
                                            required:
                                                - namespace
                                    required:
                                        - attributes
                                        - references
                            required:
                                - data
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    home_url:
                                                        type: string
                                                        nullable: true
                                                    is_listed:
                                                        type: boolean
                                                    is_private:
                                                        type: boolean
                                                    last_30_days_build_count:
                                                        type: integer
                                                    last_30_days_org_count:
                                                        type: integer
                                                    last_30_days_project_count:
                                                        type: integer
                                                    name:
                                                        type: string
                                                required:
                                                    - is_listed
                                                    - is_private
                                                    - last_30_days_build_count
                                                    - last_30_days_org_count
                                                    - last_30_days_project_count
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    namespace:
                                                        type: object
                                                        properties:
                                                            attributes:
                                                                type: object
                                                                properties:
                                                                    name:
                                                                        type: string
                                                                required:
                                                                    - name
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - attributes
                                                            - id
                                                    orb_categories:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        name:
                                                                            type: string
                                                                    required:
                                                                        - name
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - attributes
                                                                - id
                                                        nullable: true
                                                    orb_versions:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        created_at:
                                                                            type: string
                                                                            format: date-time
                                                                            nullable: true
                                                                        version:
                                                                            type: string
                                                                    required:
                                                                        - version
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - attributes
                                                                - id
                                                        nullable: true
                                                required:
                                                    - namespace
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/orb/packages/import:
        post:
            operationId: post-orb-packages-import
            tags:
                - Orb Packages
            summary: Creates a new orb package via admin import.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                is_private:
                                    type: boolean
                                    nullable: true
                                name:
                                    type: string
                                namespace_id:
                                    type: string
                                    format: uuid
                            required:
                                - name
                                - namespace_id
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    home_url:
                                                        type: string
                                                        nullable: true
                                                    is_listed:
                                                        type: boolean
                                                    is_private:
                                                        type: boolean
                                                    last_30_days_build_count:
                                                        type: integer
                                                    last_30_days_org_count:
                                                        type: integer
                                                    last_30_days_project_count:
                                                        type: integer
                                                    name:
                                                        type: string
                                                required:
                                                    - is_listed
                                                    - is_private
                                                    - last_30_days_build_count
                                                    - last_30_days_org_count
                                                    - last_30_days_project_count
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    namespace:
                                                        type: object
                                                        properties:
                                                            attributes:
                                                                type: object
                                                                properties:
                                                                    name:
                                                                        type: string
                                                                required:
                                                                    - name
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - attributes
                                                            - id
                                                    orb_categories:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        name:
                                                                            type: string
                                                                    required:
                                                                        - name
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - attributes
                                                                - id
                                                        nullable: true
                                                    orb_versions:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        created_at:
                                                                            type: string
                                                                            format: date-time
                                                                            nullable: true
                                                                        version:
                                                                            type: string
                                                                    required:
                                                                        - version
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - attributes
                                                                - id
                                                        nullable: true
                                                required:
                                                    - namespace
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/orb/packages/validate:
        post:
            operationId: post-orb-packages-validate
            tags:
                - Orb Packages
            summary: Checks whether the given orb YAML is valid.
            description: The data entity does not include an id because validate is not scoped to an existing entity.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                org_id:
                                    type: string
                                    format: uuid
                                    nullable: true
                                yaml:
                                    type: string
                            required:
                                - yaml
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    errors:
                                                        type: array
                                                        items:
                                                            type: string
                                                        nullable: true
                                                    is_valid:
                                                        type: boolean
                                                    output_yaml:
                                                        type: string
                                                        nullable: true
                                                required:
                                                    - is_valid
                                        required:
                                            - attributes
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/orb/packages/{id}:
        get:
            operationId: get-orb-packages-by-id
            tags:
                - Orb Packages
            summary: Retrieves a single package by its ID.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    home_url:
                                                        type: string
                                                        nullable: true
                                                    is_listed:
                                                        type: boolean
                                                    is_private:
                                                        type: boolean
                                                    last_30_days_build_count:
                                                        type: integer
                                                    last_30_days_org_count:
                                                        type: integer
                                                    last_30_days_project_count:
                                                        type: integer
                                                    name:
                                                        type: string
                                                required:
                                                    - is_listed
                                                    - is_private
                                                    - last_30_days_build_count
                                                    - last_30_days_org_count
                                                    - last_30_days_project_count
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    namespace:
                                                        type: object
                                                        properties:
                                                            attributes:
                                                                type: object
                                                                properties:
                                                                    name:
                                                                        type: string
                                                                required:
                                                                    - name
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - attributes
                                                            - id
                                                    orb_categories:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        name:
                                                                            type: string
                                                                    required:
                                                                        - name
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - attributes
                                                                - id
                                                        nullable: true
                                                    orb_versions:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        created_at:
                                                                            type: string
                                                                            format: date-time
                                                                            nullable: true
                                                                        version:
                                                                            type: string
                                                                    required:
                                                                        - version
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - attributes
                                                                - id
                                                        nullable: true
                                                required:
                                                    - namespace
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/orb/packages/{id}/add-category:
        post:
            operationId: post-orb-packages-by-id-add-category
            tags:
                - Orb Packages
            summary: Adds a category to the package.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                category_id:
                                    type: string
                                    format: uuid
                            required:
                                - category_id
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    home_url:
                                                        type: string
                                                        nullable: true
                                                    is_listed:
                                                        type: boolean
                                                    is_private:
                                                        type: boolean
                                                    last_30_days_build_count:
                                                        type: integer
                                                    last_30_days_org_count:
                                                        type: integer
                                                    last_30_days_project_count:
                                                        type: integer
                                                    name:
                                                        type: string
                                                required:
                                                    - is_listed
                                                    - is_private
                                                    - last_30_days_build_count
                                                    - last_30_days_org_count
                                                    - last_30_days_project_count
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    namespace:
                                                        type: object
                                                        properties:
                                                            attributes:
                                                                type: object
                                                                properties:
                                                                    name:
                                                                        type: string
                                                                required:
                                                                    - name
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - attributes
                                                            - id
                                                    orb_categories:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        name:
                                                                            type: string
                                                                    required:
                                                                        - name
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - attributes
                                                                - id
                                                        nullable: true
                                                    orb_versions:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        created_at:
                                                                            type: string
                                                                            format: date-time
                                                                            nullable: true
                                                                        version:
                                                                            type: string
                                                                    required:
                                                                        - version
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - attributes
                                                                - id
                                                        nullable: true
                                                required:
                                                    - namespace
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/orb/packages/{id}/remove-category:
        post:
            operationId: post-orb-packages-by-id-remove-category
            tags:
                - Orb Packages
            summary: Removes a category from a package.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                category_id:
                                    type: string
                                    format: uuid
                            required:
                                - category_id
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    home_url:
                                                        type: string
                                                        nullable: true
                                                    is_listed:
                                                        type: boolean
                                                    is_private:
                                                        type: boolean
                                                    last_30_days_build_count:
                                                        type: integer
                                                    last_30_days_org_count:
                                                        type: integer
                                                    last_30_days_project_count:
                                                        type: integer
                                                    name:
                                                        type: string
                                                required:
                                                    - is_listed
                                                    - is_private
                                                    - last_30_days_build_count
                                                    - last_30_days_org_count
                                                    - last_30_days_project_count
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    namespace:
                                                        type: object
                                                        properties:
                                                            attributes:
                                                                type: object
                                                                properties:
                                                                    name:
                                                                        type: string
                                                                required:
                                                                    - name
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - attributes
                                                            - id
                                                    orb_categories:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        name:
                                                                            type: string
                                                                    required:
                                                                        - name
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - attributes
                                                                - id
                                                        nullable: true
                                                    orb_versions:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        created_at:
                                                                            type: string
                                                                            format: date-time
                                                                            nullable: true
                                                                        version:
                                                                            type: string
                                                                    required:
                                                                        - version
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - attributes
                                                                - id
                                                        nullable: true
                                                required:
                                                    - namespace
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/orb/packages/{id}/set-listed:
        post:
            operationId: post-orb-packages-by-id-set-listed
            tags:
                - Orb Packages
            summary: Marks a package as listed or unlisted.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                is_listed:
                                    type: boolean
                                    nullable: true
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    home_url:
                                                        type: string
                                                        nullable: true
                                                    is_listed:
                                                        type: boolean
                                                    is_private:
                                                        type: boolean
                                                    last_30_days_build_count:
                                                        type: integer
                                                    last_30_days_org_count:
                                                        type: integer
                                                    last_30_days_project_count:
                                                        type: integer
                                                    name:
                                                        type: string
                                                required:
                                                    - is_listed
                                                    - is_private
                                                    - last_30_days_build_count
                                                    - last_30_days_org_count
                                                    - last_30_days_project_count
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    namespace:
                                                        type: object
                                                        properties:
                                                            attributes:
                                                                type: object
                                                                properties:
                                                                    name:
                                                                        type: string
                                                                required:
                                                                    - name
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - attributes
                                                            - id
                                                    orb_categories:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        name:
                                                                            type: string
                                                                    required:
                                                                        - name
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - attributes
                                                                - id
                                                        nullable: true
                                                    orb_versions:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        created_at:
                                                                            type: string
                                                                            format: date-time
                                                                            nullable: true
                                                                        version:
                                                                            type: string
                                                                    required:
                                                                        - version
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - attributes
                                                                - id
                                                        nullable: true
                                                required:
                                                    - namespace
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/orb/versions:
        get:
            operationId: get-orb-versions
            tags:
                - Orb Versions
            summary: Returns orb versions matching the given filters.
            parameters:
                - name: filter[channel]
                  in: query
                  schema:
                    type: string
                - name: filter[orb_id]
                  in: query
                  required: true
                  schema:
                    type: string
                    format: uuid
                - name: filter[ref]
                  in: query
                  schema:
                    type: string
                - name: page[cursor]
                  in: query
                  description: Opaque cursor for the next or previous page. Send back the value of page.next or page.prev from a previous response on this operation, verbatim - it is a cursor value, not a URL, and must not be constructed or decoded. Omit for the first page.
                  schema:
                    type: string
                - name: page[limit]
                  in: query
                  description: Maximum items in one page. Out-of-range values are rejected with 400 rather than clamped.
                  schema:
                    type: integer
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        created_at:
                                                            type: string
                                                            format: date-time
                                                            nullable: true
                                                        source:
                                                            type: string
                                                            nullable: true
                                                        version:
                                                            type: string
                                                    required:
                                                        - version
                                                id:
                                                    type: string
                                                    format: uuid
                                                references:
                                                    type: object
                                                    properties:
                                                        orb_package:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        name:
                                                                            type: string
                                                                            nullable: true
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - attributes
                                                                - id
                                                    required:
                                                        - orb_package
                                            required:
                                                - attributes
                                                - id
                                                - references
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        post:
            operationId: post-orb-versions
            tags:
                - Orb Versions
            summary: Creates a new orb version with the given YAML source.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                orb_id:
                                                    type: string
                                                    format: uuid
                                                version:
                                                    type: string
                                                yaml:
                                                    type: string
                                            required:
                                                - orb_id
                                                - version
                                                - yaml
                                    required:
                                        - attributes
                            required:
                                - data
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    source:
                                                        type: string
                                                        nullable: true
                                                    version:
                                                        type: string
                                                required:
                                                    - version
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    orb_package:
                                                        type: object
                                                        properties:
                                                            attributes:
                                                                type: object
                                                                properties:
                                                                    name:
                                                                        type: string
                                                                        nullable: true
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - attributes
                                                            - id
                                                required:
                                                    - orb_package
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/orb/versions/import:
        post:
            operationId: post-orb-versions-import
            tags:
                - Orb Versions
            summary: Creates a new orb version via admin import.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                orb_id:
                                    type: string
                                    format: uuid
                                orb_yaml:
                                    type: string
                                version:
                                    type: string
                            required:
                                - orb_id
                                - orb_yaml
                                - version
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    source:
                                                        type: string
                                                        nullable: true
                                                    version:
                                                        type: string
                                                required:
                                                    - version
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    orb_package:
                                                        type: object
                                                        properties:
                                                            attributes:
                                                                type: object
                                                                properties:
                                                                    name:
                                                                        type: string
                                                                        nullable: true
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - attributes
                                                            - id
                                                required:
                                                    - orb_package
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/orb/versions/{id}:
        get:
            operationId: get-orb-versions-by-id
            tags:
                - Orb Versions
            summary: Retrieves a single orb version by its ID.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
                - name: include
                  in: query
                  required: true
                  schema:
                    type: string
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    source:
                                                        type: string
                                                        nullable: true
                                                    version:
                                                        type: string
                                                required:
                                                    - version
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    orb_package:
                                                        type: object
                                                        properties:
                                                            attributes:
                                                                type: object
                                                                properties:
                                                                    name:
                                                                        type: string
                                                                        nullable: true
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - attributes
                                                            - id
                                                required:
                                                    - orb_package
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/orb/versions/{id}/promote:
        post:
            operationId: post-orb-versions-by-id-promote
            tags:
                - Orb Versions
            summary: Promote a orb version.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                segment:
                                    type: string
                                    nullable: true
                                semantic_version:
                                    type: string
                                    nullable: true
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    source:
                                                        type: string
                                                        nullable: true
                                                    version:
                                                        type: string
                                                required:
                                                    - version
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    orb_package:
                                                        type: object
                                                        properties:
                                                            attributes:
                                                                type: object
                                                                properties:
                                                                    name:
                                                                        type: string
                                                                        nullable: true
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - attributes
                                                            - id
                                                required:
                                                    - orb_package
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Either 'segment' or 'semantic_version' must be provided.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/orb/versions/{id}/source:
        get:
            operationId: get-orb-versions-by-id-source
            tags:
                - Orb Versions
            summary: Returns the raw YAML source of an orb version as text/plain.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/orgs:
        get:
            operationId: get-orgs
            tags:
                - Orgs
            summary: Resolves orgs matching the given filters.
            description: filter[slug] is optional. With it, a single org is resolved by its slug; a slug matching no org is an empty collection rather than a 404. Without it, the orgs the calling user belongs to are listed.
            parameters:
                - name: filter[slug]
                  in: query
                  schema:
                    type: string
                - name: page[cursor]
                  in: query
                  description: Opaque cursor for the next or previous page. Send back the value of page.next or page.prev from a previous response on this operation, verbatim - it is a cursor value, not a URL, and must not be constructed or decoded. Omit for the first page.
                  schema:
                    type: string
                - name: page[limit]
                  in: query
                  description: Maximum items in one page. Out-of-range values are rejected with 400 rather than clamped.
                  schema:
                    type: integer
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        avatar:
                                                            type: object
                                                            properties:
                                                                url:
                                                                    type: string
                                                            required:
                                                                - url
                                                        name:
                                                            type: string
                                                        vcs:
                                                            type: object
                                                            properties:
                                                                provider:
                                                                    type: string
                                                            required:
                                                                - provider
                                                            nullable: true
                                                    required:
                                                        - avatar
                                                        - name
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - attributes
                                                - id
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/orgs/{id}:
        get:
            operationId: get-orgs-by-id
            tags:
                - Orgs
            summary: Fetches an org by its UUID.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    avatar:
                                                        type: object
                                                        properties:
                                                            url:
                                                                type: string
                                                        required:
                                                            - url
                                                    name:
                                                        type: string
                                                    vcs:
                                                        type: object
                                                        properties:
                                                            provider:
                                                                type: string
                                                        required:
                                                            - provider
                                                        nullable: true
                                                required:
                                                    - avatar
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - attributes
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/orgs/{id}/settings:
        get:
            operationId: get-orgs-by-id-settings
            tags:
                - Orgs
            summary: Returns settings for an org.
            description: Settings are a singleton sub-resource of the org, so the data entity does not include an id - the org's id is in the path.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    enable_ai_agents:
                                                        type: boolean
                                                    enable_ai_error_summarization:
                                                        type: boolean
                                                    enable_certified_public_orbs:
                                                        type: boolean
                                                    enable_chunk_ip_ranges:
                                                        type: boolean
                                                    enable_image_brownouts:
                                                        type: boolean
                                                    enable_marketing_tracking:
                                                        type: boolean
                                                    enable_minor_ai_features:
                                                        type: boolean
                                                    enable_preferences_tracking:
                                                        type: boolean
                                                    enable_private_orbs:
                                                        type: boolean
                                                    enable_resource_class_brownouts:
                                                        type: boolean
                                                    enable_statistics_tracking:
                                                        type: boolean
                                                    enable_uncertified_public_orbs:
                                                        type: boolean
                                                    enable_unversioned_config:
                                                        type: boolean
                                                    is_bitbucket_workspace_member_org_member:
                                                        type: boolean
                                                    is_context_group_restriction_required:
                                                        type: boolean
                                                    is_privacy_optout_enforced:
                                                        type: boolean
                                                    is_runner_terms_of_service_accepted:
                                                        type: boolean
                                                    is_running_disabled:
                                                        type: boolean
                                                    is_user_checkout_keys_disabled:
                                                        type: boolean
                                                required:
                                                    - enable_ai_agents
                                                    - enable_ai_error_summarization
                                                    - enable_certified_public_orbs
                                                    - enable_chunk_ip_ranges
                                                    - enable_image_brownouts
                                                    - enable_marketing_tracking
                                                    - enable_minor_ai_features
                                                    - enable_preferences_tracking
                                                    - enable_private_orbs
                                                    - enable_resource_class_brownouts
                                                    - enable_statistics_tracking
                                                    - enable_uncertified_public_orbs
                                                    - enable_unversioned_config
                                                    - is_bitbucket_workspace_member_org_member
                                                    - is_context_group_restriction_required
                                                    - is_privacy_optout_enforced
                                                    - is_runner_terms_of_service_accepted
                                                    - is_running_disabled
                                                    - is_user_checkout_keys_disabled
                                        required:
                                            - attributes
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/orgs/{id}/update-settings:
        post:
            operationId: post-orgs-by-id-update-settings
            tags:
                - Orgs
            summary: Modifies settings for an org.
            description: Settings are a singleton sub-resource of the org, so the data entity does not include an id - the org's id is in the path.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                enable_ai_agents:
                                    type: boolean
                                    nullable: true
                                enable_ai_error_summarization:
                                    type: boolean
                                    nullable: true
                                enable_certified_public_orbs:
                                    type: boolean
                                    nullable: true
                                enable_chunk_ip_ranges:
                                    type: boolean
                                    nullable: true
                                enable_image_brownouts:
                                    type: boolean
                                    nullable: true
                                enable_marketing_tracking:
                                    type: boolean
                                    nullable: true
                                enable_minor_ai_features:
                                    type: boolean
                                    nullable: true
                                enable_preferences_tracking:
                                    type: boolean
                                    nullable: true
                                enable_private_orbs:
                                    type: boolean
                                    nullable: true
                                enable_resource_class_brownouts:
                                    type: boolean
                                    nullable: true
                                enable_statistics_tracking:
                                    type: boolean
                                    nullable: true
                                enable_uncertified_public_orbs:
                                    type: boolean
                                    nullable: true
                                enable_unversioned_config:
                                    type: boolean
                                    nullable: true
                                is_bitbucket_workspace_member_org_member:
                                    type: boolean
                                    nullable: true
                                is_context_group_restriction_required:
                                    type: boolean
                                    nullable: true
                                is_privacy_optout_enforced:
                                    type: boolean
                                    nullable: true
                                is_runner_terms_of_service_accepted:
                                    type: boolean
                                    nullable: true
                                is_running_disabled:
                                    type: boolean
                                    nullable: true
                                is_user_checkout_keys_disabled:
                                    type: boolean
                                    nullable: true
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    enable_ai_agents:
                                                        type: boolean
                                                    enable_ai_error_summarization:
                                                        type: boolean
                                                    enable_certified_public_orbs:
                                                        type: boolean
                                                    enable_chunk_ip_ranges:
                                                        type: boolean
                                                    enable_image_brownouts:
                                                        type: boolean
                                                    enable_marketing_tracking:
                                                        type: boolean
                                                    enable_minor_ai_features:
                                                        type: boolean
                                                    enable_preferences_tracking:
                                                        type: boolean
                                                    enable_private_orbs:
                                                        type: boolean
                                                    enable_resource_class_brownouts:
                                                        type: boolean
                                                    enable_statistics_tracking:
                                                        type: boolean
                                                    enable_uncertified_public_orbs:
                                                        type: boolean
                                                    enable_unversioned_config:
                                                        type: boolean
                                                    is_bitbucket_workspace_member_org_member:
                                                        type: boolean
                                                    is_context_group_restriction_required:
                                                        type: boolean
                                                    is_privacy_optout_enforced:
                                                        type: boolean
                                                    is_runner_terms_of_service_accepted:
                                                        type: boolean
                                                    is_running_disabled:
                                                        type: boolean
                                                    is_user_checkout_keys_disabled:
                                                        type: boolean
                                                required:
                                                    - enable_ai_agents
                                                    - enable_ai_error_summarization
                                                    - enable_certified_public_orbs
                                                    - enable_chunk_ip_ranges
                                                    - enable_image_brownouts
                                                    - enable_marketing_tracking
                                                    - enable_minor_ai_features
                                                    - enable_preferences_tracking
                                                    - enable_private_orbs
                                                    - enable_resource_class_brownouts
                                                    - enable_statistics_tracking
                                                    - enable_uncertified_public_orbs
                                                    - enable_unversioned_config
                                                    - is_bitbucket_workspace_member_org_member
                                                    - is_context_group_restriction_required
                                                    - is_privacy_optout_enforced
                                                    - is_runner_terms_of_service_accepted
                                                    - is_running_disabled
                                                    - is_user_checkout_keys_disabled
                                        required:
                                            - attributes
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/pipelines:
        get:
            operationId: get-pipelines
            tags:
                - Pipelines
            summary: Lists a project's pipelines, including its synthetic OAuth pipeline.
            description: filter[project_id] is required — there is no unscoped/global listing. A pipeline that can be fetched via Get must also appear in this listing.
            parameters:
                - name: filter[project_id]
                  in: query
                  required: true
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        post:
            operationId: post-pipelines
            tags:
                - Pipelines
            summary: Creates a pipeline (config source) under the project named by project_id.
            description: Returns the full created entity (shape-identical to Get).
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                checkout:
                                                    type: object
                                                    properties:
                                                        vcs:
                                                            type: object
                                                            properties:
                                                                provider:
                                                                    type: string
                                                                repo_full_name:
                                                                    type: string
                                                                repo_id:
                                                                    type: string
                                                            required:
                                                                - provider
                                                                - repo_full_name
                                                                - repo_id
                                                    required:
                                                        - vcs
                                                config:
                                                    type: object
                                                    properties:
                                                        file_path:
                                                            type: string
                                                        hosted:
                                                            type: object
                                                            properties:
                                                                provider:
                                                                    type: string
                                                            required:
                                                                - provider
                                                        type:
                                                            type: string
                                                        vcs:
                                                            type: object
                                                            properties:
                                                                provider:
                                                                    type: string
                                                                repo_full_name:
                                                                    type: string
                                                                repo_id:
                                                                    type: string
                                                            required:
                                                                - provider
                                                                - repo_full_name
                                                                - repo_id
                                                    required:
                                                        - file_path
                                                        - hosted
                                                        - type
                                                        - vcs
                                                description:
                                                    type: string
                                                    nullable: true
                                                name:
                                                    type: string
                                            required:
                                                - checkout
                                                - config
                                                - name
                                        references:
                                            type: object
                                            properties:
                                                project:
                                                    type: object
                                                    properties:
                                                        id:
                                                            type: string
                                                            format: uuid
                                                    required:
                                                        - id
                                            required:
                                                - project
                                    required:
                                        - attributes
                                        - references
                            required:
                                - data
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    checkout:
                                                        type: object
                                                        properties:
                                                            type:
                                                                type: string
                                                            vcs:
                                                                type: object
                                                                properties:
                                                                    provider:
                                                                        type: string
                                                                    repo_full_name:
                                                                        type: string
                                                                        nullable: true
                                                                    repo_id:
                                                                        type: string
                                                                        nullable: true
                                                                required:
                                                                    - provider
                                                        required:
                                                            - type
                                                            - vcs
                                                    config:
                                                        type: object
                                                        properties:
                                                            file_path:
                                                                type: string
                                                            hosted:
                                                                type: object
                                                                properties:
                                                                    provider:
                                                                        type: string
                                                                required:
                                                                    - provider
                                                            type:
                                                                type: string
                                                            vcs:
                                                                type: object
                                                                properties:
                                                                    provider:
                                                                        type: string
                                                                    repo_full_name:
                                                                        type: string
                                                                        nullable: true
                                                                    repo_id:
                                                                        type: string
                                                                        nullable: true
                                                                required:
                                                                    - provider
                                                        required:
                                                            - file_path
                                                            - hosted
                                                            - type
                                                            - vcs
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    description:
                                                        type: string
                                                        nullable: true
                                                    name:
                                                        type: string
                                                required:
                                                    - checkout
                                                    - config
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    project:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - project
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/pipelines/{id}:
        get:
            operationId: get-pipelines-by-id
            tags:
                - Pipelines
            summary: Gets a pipeline by ID.
            description: The optional filter[project_id] query parameter scopes the lookup; it is required to resolve synthetic OAuth pipelines, which have no stored row and are derived from the project.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    checkout:
                                                        type: object
                                                        properties:
                                                            type:
                                                                type: string
                                                            vcs:
                                                                type: object
                                                                properties:
                                                                    provider:
                                                                        type: string
                                                                    repo_full_name:
                                                                        type: string
                                                                        nullable: true
                                                                    repo_id:
                                                                        type: string
                                                                        nullable: true
                                                                required:
                                                                    - provider
                                                        required:
                                                            - type
                                                            - vcs
                                                    config:
                                                        type: object
                                                        properties:
                                                            file_path:
                                                                type: string
                                                            hosted:
                                                                type: object
                                                                properties:
                                                                    provider:
                                                                        type: string
                                                                required:
                                                                    - provider
                                                            type:
                                                                type: string
                                                            vcs:
                                                                type: object
                                                                properties:
                                                                    provider:
                                                                        type: string
                                                                    repo_full_name:
                                                                        type: string
                                                                        nullable: true
                                                                    repo_id:
                                                                        type: string
                                                                        nullable: true
                                                                required:
                                                                    - provider
                                                        required:
                                                            - file_path
                                                            - hosted
                                                            - type
                                                            - vcs
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    description:
                                                        type: string
                                                        nullable: true
                                                    name:
                                                        type: string
                                                required:
                                                    - checkout
                                                    - config
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    project:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - project
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        delete:
            operationId: delete-pipelines-by-id
            tags:
                - Pipelines
            summary: Deletes a pipeline by ID.
            description: The optional filter[project_id] query parameter scopes the lookup; it is required to identify synthetic OAuth pipelines, which have no stored row and are derived from the project.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/pipelines/{id}/update:
        post:
            operationId: post-pipelines-by-id-update
            tags:
                - Pipelines
            summary: Partially updates a pipeline by ID.
            description: Only the fields present in the request body (name, description, config.file_path) are changed. The optional filter[project_id] query parameter scopes the lookup; synthetic OAuth pipelines have no stored row and cannot be updated.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                config:
                                    type: object
                                    properties:
                                        file_path:
                                            type: string
                                    required:
                                        - file_path
                                description:
                                    type: string
                                    nullable: true
                                name:
                                    type: string
                                    nullable: true
                            required:
                                - config
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    checkout:
                                                        type: object
                                                        properties:
                                                            type:
                                                                type: string
                                                            vcs:
                                                                type: object
                                                                properties:
                                                                    provider:
                                                                        type: string
                                                                    repo_full_name:
                                                                        type: string
                                                                        nullable: true
                                                                    repo_id:
                                                                        type: string
                                                                        nullable: true
                                                                required:
                                                                    - provider
                                                        required:
                                                            - type
                                                            - vcs
                                                    config:
                                                        type: object
                                                        properties:
                                                            file_path:
                                                                type: string
                                                            hosted:
                                                                type: object
                                                                properties:
                                                                    provider:
                                                                        type: string
                                                                required:
                                                                    - provider
                                                            type:
                                                                type: string
                                                            vcs:
                                                                type: object
                                                                properties:
                                                                    provider:
                                                                        type: string
                                                                    repo_full_name:
                                                                        type: string
                                                                        nullable: true
                                                                    repo_id:
                                                                        type: string
                                                                        nullable: true
                                                                required:
                                                                    - provider
                                                        required:
                                                            - file_path
                                                            - hosted
                                                            - type
                                                            - vcs
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    description:
                                                        type: string
                                                        nullable: true
                                                    name:
                                                        type: string
                                                required:
                                                    - checkout
                                                    - config
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    project:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - project
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/projects:
        get:
            operationId: get-projects
            tags:
                - Projects
            summary: Resolves projects matching the given filters.
            description: |-
                Exactly one of filter[slug] (resolving a single project) or filter[org_id] (listing an org's projects) must be supplied. Neither an unfiltered list nor both filters together is supported, so either is a 400.

                filter[name] is optional and applies only to the filter[org_id] form, where it narrows the org's projects by a case-insensitive name search. Combining it with filter[slug] is a 400.

                An org that does not exist, or that the caller cannot see, is a 404. A slug that matches no project is an empty collection.

                Notes on pagination:
            parameters:
                - name: filter[name]
                  in: query
                  schema:
                    type: string
                - name: filter[org_id]
                  in: query
                  schema:
                    type: string
                    format: uuid
                - name: filter[slug]
                  in: query
                  schema:
                    type: string
                - name: page[cursor]
                  in: query
                  description: Opaque cursor for the next or previous page. Send back the value of page.next or page.prev from a previous response on this operation, verbatim - it is a cursor value, not a URL, and must not be constructed or decoded. Omit for the first page.
                  schema:
                    type: string
                - name: page[limit]
                  in: query
                  description: Maximum items in one page. Out-of-range values are rejected with 400 rather than clamped.
                  schema:
                    type: integer
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        name:
                                                            type: string
                                                    required:
                                                        - name
                                                id:
                                                    type: string
                                                    format: uuid
                                                references:
                                                    type: object
                                                    properties:
                                                        org:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                    required:
                                                        - org
                                            required:
                                                - attributes
                                                - id
                                                - references
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/projects/{id}:
        get:
            operationId: get-projects-by-id
            tags:
                - Projects
            summary: Fetches a project by its UUID.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    name:
                                                        type: string
                                                required:
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    org:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - org
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/projects/{id}/environment-variables:
        get:
            operationId: get-projects-by-id-environment-variables
            tags:
                - Projects
            summary: Returns environment variables for a project.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        name:
                                                            type: string
                                                        value:
                                                            type: string
                                                    required:
                                                        - name
                                                        - value
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - attributes
                                                - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        post:
            operationId: post-projects-by-id-environment-variables
            tags:
                - Projects
            summary: Sets a project environment variable.
            description: An environment variable is keyed by name within its project, so the data entity does not include an id.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                name:
                                    type: string
                                value:
                                    type: string
                            required:
                                - name
                                - value
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    name:
                                                        type: string
                                                    value:
                                                        type: string
                                                required:
                                                    - name
                                                    - value
                                        required:
                                            - attributes
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/projects/{id}/environment-variables/{name}:
        delete:
            operationId: delete-projects-by-id-environment-variables-by-name
            tags:
                - Projects
            summary: Removes a project environment variable.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
                - name: name
                  in: path
                  required: true
                  description: The name.
                  schema:
                    type: string
            responses:
                204:
                    description: No Content
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/projects/{id}/rollback:
        post:
            operationId: post-projects-by-id-rollback
            tags:
                - Projects
            summary: Rolls a deployed component back to an earlier version.
            description: |-
                The component and the environment identify what is running the version being rolled back; current_version must match the version deployed there, so a caller working from stale state cannot roll back a version that has since been superseded.

                How the rollback runs depends on the project's deploy settings: a project with a rollback pipeline configured gets a pipeline run, and one without gets a restore-version command sent to the release agent deployed in that environment. data.id is that run or that command and rollback_type says which, since the two are polled in different places.

                The response is 200 rather than 202 because data.id is a handle to work in progress, not a resource newly created at a V3 address there would be a Location to point at.

                A component or environment the caller may not deploy to is reported as not found, as is a component and environment that do not describe one deployed thing in this project, so the response does not reveal whether the ids exist.

                EXPERIMENTAL — this endpoint is experimental and may change without notice. Field names and response shapes are not yet stable, and the deploy API as a whole is still under review. Do not depend on it in production clients.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                checkout_ref:
                                    type: string
                                component_id:
                                    type: string
                                    format: uuid
                                config_ref:
                                    type: string
                                current_version:
                                    type: string
                                environment_id:
                                    type: string
                                    format: uuid
                                namespace:
                                    type: string
                                parameters:
                                    type: string
                                    nullable: true
                                reason:
                                    type: string
                                target_version:
                                    type: string
                            required:
                                - checkout_ref
                                - component_id
                                - config_ref
                                - current_version
                                - environment_id
                                - namespace
                                - reason
                                - target_version
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    rollback_type:
                                                        type: string
                                                required:
                                                    - rollback_type
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    deploy_component:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    deploy_environment:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    project:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - deploy_component
                                                    - deploy_environment
                                                    - project
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: The current version is not the version deployed there.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                409:
                    description: A command for that component instance is already being handled.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/projects/{id}/settings:
        get:
            operationId: get-projects-by-id-settings
            tags:
                - Projects
            summary: Returns settings for a project.
            description: Settings are a singleton sub-resource of the project, so the data entity does not include an id - the project's id is in the path.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    can_pass_secrets_to_fork_pr_jobs:
                                                        type: boolean
                                                    can_set_github_status:
                                                        type: boolean
                                                    enable_ai_error_summarization:
                                                        type: boolean
                                                    enable_auto_cancel_redundant_workflows:
                                                        type: boolean
                                                    enable_building_fork_prs:
                                                        type: boolean
                                                    enable_dynamic_config:
                                                        type: boolean
                                                    enable_unversioned_config:
                                                        type: boolean
                                                    is_admin_required_for_writing_settings:
                                                        type: boolean
                                                    is_build_prs_only:
                                                        type: boolean
                                                    is_oss:
                                                        type: boolean
                                                    is_running_disabled:
                                                        type: boolean
                                                    is_ssh_disabled:
                                                        type: boolean
                                                    pr_only_branch_overrides:
                                                        type: array
                                                        items:
                                                            type: string
                                                required:
                                                    - can_pass_secrets_to_fork_pr_jobs
                                                    - can_set_github_status
                                                    - enable_ai_error_summarization
                                                    - enable_auto_cancel_redundant_workflows
                                                    - enable_building_fork_prs
                                                    - enable_dynamic_config
                                                    - enable_unversioned_config
                                                    - is_admin_required_for_writing_settings
                                                    - is_build_prs_only
                                                    - is_oss
                                                    - is_running_disabled
                                                    - is_ssh_disabled
                                                    - pr_only_branch_overrides
                                        required:
                                            - attributes
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/projects/{id}/update-settings:
        post:
            operationId: post-projects-by-id-update-settings
            tags:
                - Projects
            summary: Modifies settings for a project.
            description: Settings are a singleton sub-resource of the project, so the data entity does not include an id - the project's id is in the path.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                can_pass_secrets_to_fork_pr_jobs:
                                    type: boolean
                                    nullable: true
                                can_set_github_status:
                                    type: boolean
                                    nullable: true
                                enable_ai_error_summarization:
                                    type: boolean
                                    nullable: true
                                enable_auto_cancel_redundant_workflows:
                                    type: boolean
                                    nullable: true
                                enable_building_fork_prs:
                                    type: boolean
                                    nullable: true
                                enable_dynamic_config:
                                    type: boolean
                                    nullable: true
                                enable_unversioned_config:
                                    type: boolean
                                    nullable: true
                                is_admin_required_for_writing_settings:
                                    type: boolean
                                    nullable: true
                                is_build_prs_only:
                                    type: boolean
                                    nullable: true
                                is_oss:
                                    type: boolean
                                    nullable: true
                                is_running_disabled:
                                    type: boolean
                                    nullable: true
                                is_ssh_disabled:
                                    type: boolean
                                    nullable: true
                                pr_only_branch_overrides:
                                    type: array
                                    items:
                                        type: string
                                    nullable: true
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    can_pass_secrets_to_fork_pr_jobs:
                                                        type: boolean
                                                    can_set_github_status:
                                                        type: boolean
                                                    enable_ai_error_summarization:
                                                        type: boolean
                                                    enable_auto_cancel_redundant_workflows:
                                                        type: boolean
                                                    enable_building_fork_prs:
                                                        type: boolean
                                                    enable_dynamic_config:
                                                        type: boolean
                                                    enable_unversioned_config:
                                                        type: boolean
                                                    is_admin_required_for_writing_settings:
                                                        type: boolean
                                                    is_build_prs_only:
                                                        type: boolean
                                                    is_oss:
                                                        type: boolean
                                                    is_running_disabled:
                                                        type: boolean
                                                    is_ssh_disabled:
                                                        type: boolean
                                                    pr_only_branch_overrides:
                                                        type: array
                                                        items:
                                                            type: string
                                                required:
                                                    - can_pass_secrets_to_fork_pr_jobs
                                                    - can_set_github_status
                                                    - enable_ai_error_summarization
                                                    - enable_auto_cancel_redundant_workflows
                                                    - enable_building_fork_prs
                                                    - enable_dynamic_config
                                                    - enable_unversioned_config
                                                    - is_admin_required_for_writing_settings
                                                    - is_build_prs_only
                                                    - is_oss
                                                    - is_running_disabled
                                                    - is_ssh_disabled
                                                    - pr_only_branch_overrides
                                        required:
                                            - attributes
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/provider/branches:
        get:
            operationId: get-provider-branches
            tags:
                - Provider Branches
            summary: Lists branches for a repository.
            description: Requires filter[org_id] (the organization), filter[provider] (the integration provider), and filter[repo_id] (the external repository id). Supports cursor pagination via page[limit] and page[cursor]. The cursor encodes the limit from the originating request; sending page[limit] alongside page[cursor] is rejected with 400.
            parameters:
                - name: filter[org_id]
                  in: query
                  required: true
                  schema:
                    type: string
                    format: uuid
                - name: filter[provider]
                  in: query
                  required: true
                  schema:
                    type: string
                - name: filter[repo_id]
                  in: query
                  required: true
                  schema:
                    type: string
                - name: page[cursor]
                  in: query
                  description: Opaque cursor for the next or previous page. Send back the value of page.next or page.prev from a previous response on this operation, verbatim - it is a cursor value, not a URL, and must not be constructed or decoded. Omit for the first page.
                  schema:
                    type: string
                - name: page[limit]
                  in: query
                  description: Maximum items in one page. Out-of-range values are rejected with 400 rather than clamped.
                  schema:
                    type: integer
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - id
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/provider/connections:
        get:
            operationId: get-provider-connections
            tags:
                - Provider Connections
            summary: Lists an organization's provider connections.
            description: |-
                Returns every connection that authorizes CircleCI to act for the organization — a GitHub App installation, a GitHub Server installation, an Origin installation — with the provider's live view of each. Custom webhook connections are not included. Requires filter[org_id] and view-org on that organization.

                Each item always carries its stored fields. The provider is also asked for the installation as it currently stands and for the calling user's identity there; either failing degrades that item rather than the response, populating connection_error or authorization_error and omitting the fields it could not fill. An organization with no connections is an empty list, not a 404.

                A connection appears only once the customer has finished authorizing it at the provider. A setup that has been started and not completed is not listed, and is indistinguishable here from one that was never started.
            parameters:
                - name: filter[org_id]
                  in: query
                  required: true
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/provider/connections/setup:
        post:
            operationId: post-provider-connections-setup
            tags:
                - Provider Connections
            summary: Starts connecting a provider to an organization.
            description: Returns where to send the user to finish the connection at the provider. next_step "redirect" carries the url that connects an app CircleCI has already registered with the provider; "register" carries a manifest and state_token for the user to register one first. Nothing is connected when this returns. Requires filter[org_id] and manage-org on that organization. Each call mints and stores a fresh state token, valid for one hour, so this endpoint is deliberately not idempotent.
            parameters:
                - name: filter[org_id]
                  in: query
                  required: true
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                return_url:
                                    type: string
                                    nullable: true
                                type:
                                    type: string
                                vcs:
                                    type: object
                                    properties:
                                        provider:
                                            type: string
                                        url:
                                            type: string
                                            nullable: true
                                    required:
                                        - provider
                            required:
                                - type
                                - vcs
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    manifest:
                                                        type: string
                                                        nullable: true
                                                    next_step:
                                                        type: string
                                                    state_token:
                                                        type: string
                                                        nullable: true
                                                    url:
                                                        type: string
                                                        nullable: true
                                                required:
                                                    - next_step
                                        required:
                                            - attributes
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/provider/repositories:
        get:
            operationId: get-provider-repositories
            tags:
                - Provider Repositories
            summary: Lists repositories for an installation.
            description: |-
                Returns the repositories accessible for the specified organization's installation. Requires filter[org_id] and filter[provider], which must be one of github_app, github_server or origin. Supports cursor pagination via page[limit] and page[cursor]. The cursor encodes the limit from the originating request; sending page[limit] alongside page[cursor] with a different value is rejected with 400.

                What "accessible" means depends on the provider. For github_app and github_server the results are what the calling user's own credential can see, so two members of one organization may get different lists. Origin authorizes by installation rather than by user, so every member with view-org gets the whole installation.

                Origin reports neither repository visibility nor a web URL, so origin items omit html_url and report is_private as true — a conservative default rather than a value read from the provider.
            parameters:
                - name: filter[org_id]
                  in: query
                  required: true
                  schema:
                    type: string
                    format: uuid
                - name: filter[provider]
                  in: query
                  required: true
                  schema:
                    type: string
                - name: page[cursor]
                  in: query
                  description: Opaque cursor for the next or previous page. Send back the value of page.next or page.prev from a previous response on this operation, verbatim - it is a cursor value, not a URL, and must not be constructed or decoded. Omit for the first page.
                  schema:
                    type: string
                - name: page[limit]
                  in: query
                  description: Maximum items in one page. Out-of-range values are rejected with 400 rather than clamped.
                  schema:
                    type: integer
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - id
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/runner/agents:
        get:
            operationId: get-runner-agents
            tags:
                - Runner Agents
            summary: Lists the runner agents for a resource class.
            parameters:
                - name: filter[resource_class]
                  in: query
                  required: true
                  schema:
                    type: string
                - name: page[cursor]
                  in: query
                  description: Opaque cursor for the next or previous page. Send back the value of page.next or page.prev from a previous response on this operation, verbatim - it is a cursor value, not a URL, and must not be constructed or decoded. Omit for the first page.
                  schema:
                    type: string
                - name: page[limit]
                  in: query
                  description: Maximum items in one page. Out-of-range values are rejected with 400 rather than clamped.
                  schema:
                    type: integer
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - id
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Resource_class is not valid.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                503:
                    description: Unable to determine agent status.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
    /api/v3/runner/resource-classes:
        get:
            operationId: get-runner-resource-classes
            tags:
                - Runner Resource Classes
            summary: Lists the runner resource classes for an organization.
            parameters:
                - name: filter[org_id]
                  in: query
                  required: true
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - id
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                503:
                    description: Permission check unavailable.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
        post:
            operationId: post-runner-resource-classes
            tags:
                - Runner Resource Classes
            summary: Creates a runner resource class in the organization.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                description:
                                                    type: string
                                                resource_class:
                                                    type: string
                                            required:
                                                - description
                                                - resource_class
                                        references:
                                            type: object
                                            properties:
                                                org:
                                                    type: object
                                                    properties:
                                                        id:
                                                            type: string
                                                            format: uuid
                                                    required:
                                                        - id
                                            required:
                                                - org
                                    required:
                                        - attributes
                                        - references
                            required:
                                - data
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - id
                                required:
                                    - data
                400:
                    description: References.org.id is required.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                409:
                    description: Resource class already exists.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                503:
                    description: Permission check unavailable.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
    /api/v3/runner/resource-classes/{id}:
        get:
            operationId: get-runner-resource-classes-by-id
            tags:
                - Runner Resource Classes
            summary: Returns a single runner resource class by id.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                503:
                    description: Permission check unavailable.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
        delete:
            operationId: delete-runner-resource-classes-by-id
            tags:
                - Runner Resource Classes
            summary: Deletes a runner resource class.
            description: With ?force=true it first removes any tokens; without it, a resource class that still has tokens is rejected.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
                - name: force
                  in: query
                  required: true
                  schema:
                    type: string
            responses:
                400:
                    description: Force must be a boolean.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                409:
                    description: Conflict
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                503:
                    description: Permission check unavailable.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
    /api/v3/runner/resource-classes/{id}/update:
        post:
            operationId: post-runner-resource-classes-by-id-update
            tags:
                - Runner Resource Classes
            summary: Performs a partial update of the mutable fields.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                description:
                                    type: string
                            required:
                                - description
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/runner/tokens:
        get:
            operationId: get-runner-tokens
            tags:
                - Runner Tokens
            summary: Lists the tokens for a runner resource class.
            parameters:
                - name: filter[resource_class]
                  in: query
                  required: true
                  schema:
                    type: string
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - id
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Resource_class is not valid.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                503:
                    description: Permission check unavailable.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
        post:
            operationId: post-runner-tokens
            tags:
                - Runner Tokens
            summary: Creates a runner resource-class token.
            description: The raw token value is returned once in this response and never again.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                nickname:
                                                    type: string
                                            required:
                                                - nickname
                                        references:
                                            type: object
                                            properties:
                                                resource_class:
                                                    type: object
                                                    properties:
                                                        id:
                                                            type: string
                                                            format: uuid
                                                    required:
                                                        - id
                                            required:
                                                - resource_class
                                    required:
                                        - attributes
                                        - references
                            required:
                                - data
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                    nickname:
                                                        type: string
                                                    token:
                                                        type: string
                                                required:
                                                    - created_at
                                                    - nickname
                                                    - token
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    resource_class:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - resource_class
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: References.resource_class.id is required.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                503:
                    description: Permission check unavailable.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
    /api/v3/runner/tokens/{id}:
        get:
            operationId: get-runner-tokens-by-id
            tags:
                - Runner Tokens
            summary: Returns a single runner resource-class token by id.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                    nickname:
                                                        type: string
                                                required:
                                                    - created_at
                                                    - nickname
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    resource_class:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - resource_class
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                503:
                    description: Permission check unavailable.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
        delete:
            operationId: delete-runner-tokens-by-id
            tags:
                - Runner Tokens
            summary: Deletes a runner resource-class token by id.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                503:
                    description: Permission check unavailable.
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
    /api/v3/runs:
        get:
            operationId: get-runs
            tags:
                - Runs
            summary: Returns a paginated list of runs.
            description: The returned list can be for a single project, or the caller's own recent runs when filter[user_id]=me.
            parameters:
                - name: filter[project_id]
                  in: query
                  schema:
                    type: string
                    format: uuid
                - name: filter[user_id]
                  in: query
                  schema:
                    type: string
                - name: page[cursor]
                  in: query
                  description: Opaque cursor for the next or previous page. Send back the value of page.next or page.prev from a previous response on this operation, verbatim - it is a cursor value, not a URL, and must not be constructed or decoded. Omit for the first page.
                  schema:
                    type: string
                - name: page[limit]
                  in: query
                  description: Maximum items in one page. Out-of-range values are rejected with 400 rather than clamped.
                  schema:
                    type: integer
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        created_at:
                                                            type: string
                                                            format: date-time
                                                        current_outcome:
                                                            type: string
                                                            nullable: true
                                                        errors:
                                                            type: array
                                                            items:
                                                                type: object
                                                                properties:
                                                                    message:
                                                                        type: string
                                                                    type:
                                                                        type: string
                                                                required:
                                                                    - message
                                                                    - type
                                                            nullable: true
                                                        number:
                                                            type: integer
                                                        phase:
                                                            type: string
                                                        warnings:
                                                            type: array
                                                            items:
                                                                type: object
                                                                properties:
                                                                    message:
                                                                        type: string
                                                                    type:
                                                                        type: string
                                                                required:
                                                                    - message
                                                                    - type
                                                            nullable: true
                                                        workflows:
                                                            type: object
                                                            properties:
                                                                count_by_outcome:
                                                                    type: object
                                                                    additionalProperties:
                                                                        type: integer
                                                                count_by_phase:
                                                                    type: object
                                                                    additionalProperties:
                                                                        type: integer
                                                                is_truncated:
                                                                    type: boolean
                                                                items:
                                                                    type: array
                                                                    items:
                                                                        type: object
                                                                        properties:
                                                                            auto_rerun:
                                                                                type: object
                                                                                properties:
                                                                                    max_reruns:
                                                                                        type: integer
                                                                                    number:
                                                                                        type: integer
                                                                                required:
                                                                                    - max_reruns
                                                                                    - number
                                                                                nullable: true
                                                                            created_at:
                                                                                type: string
                                                                                format: date-time
                                                                                nullable: true
                                                                            current_outcome:
                                                                                type: string
                                                                                nullable: true
                                                                            ended_at:
                                                                                type: string
                                                                                format: date-time
                                                                                nullable: true
                                                                            id:
                                                                                type: string
                                                                                format: uuid
                                                                            jobs:
                                                                                type: object
                                                                                properties:
                                                                                    count_by_outcome:
                                                                                        type: object
                                                                                        additionalProperties:
                                                                                            type: integer
                                                                                    count_by_phase:
                                                                                        type: object
                                                                                        additionalProperties:
                                                                                            type: integer
                                                                                    is_truncated:
                                                                                        type: boolean
                                                                                    items:
                                                                                        type: array
                                                                                        items:
                                                                                            type: object
                                                                                            properties:
                                                                                                ended_at:
                                                                                                    type: string
                                                                                                    format: date-time
                                                                                                    nullable: true
                                                                                                id:
                                                                                                    type: string
                                                                                                    format: uuid
                                                                                                name:
                                                                                                    type: string
                                                                                                    nullable: true
                                                                                                number:
                                                                                                    type: integer
                                                                                                    nullable: true
                                                                                                outcome:
                                                                                                    type: string
                                                                                                    nullable: true
                                                                                                phase:
                                                                                                    type: string
                                                                                                    nullable: true
                                                                                                started_at:
                                                                                                    type: string
                                                                                                    format: date-time
                                                                                                    nullable: true
                                                                                                type:
                                                                                                    type: string
                                                                                                    nullable: true
                                                                                            required:
                                                                                                - id
                                                                                    total_count:
                                                                                        type: integer
                                                                                required:
                                                                                    - count_by_outcome
                                                                                    - count_by_phase
                                                                                    - is_truncated
                                                                                    - items
                                                                                    - total_count
                                                                                nullable: true
                                                                            name:
                                                                                type: string
                                                                                nullable: true
                                                                            outcome:
                                                                                type: string
                                                                                nullable: true
                                                                            phase:
                                                                                type: string
                                                                                nullable: true
                                                                            tag:
                                                                                type: string
                                                                                nullable: true
                                                                        required:
                                                                            - id
                                                                total_count:
                                                                    type: integer
                                                            required:
                                                                - count_by_outcome
                                                                - count_by_phase
                                                                - is_truncated
                                                                - items
                                                                - total_count
                                                            nullable: true
                                                    required:
                                                        - created_at
                                                        - number
                                                        - phase
                                                id:
                                                    type: string
                                                    format: uuid
                                                references:
                                                    type: object
                                                    properties:
                                                        event:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        action:
                                                                            type: string
                                                                            nullable: true
                                                                        type:
                                                                            type: string
                                                                            nullable: true
                                                                        vcs:
                                                                            type: object
                                                                            properties:
                                                                                branch:
                                                                                    type: string
                                                                                    nullable: true
                                                                                commit:
                                                                                    type: object
                                                                                    properties:
                                                                                        author:
                                                                                            type: object
                                                                                            properties:
                                                                                                avatar_url:
                                                                                                    type: string
                                                                                                    nullable: true
                                                                                                login:
                                                                                                    type: string
                                                                                                    nullable: true
                                                                                                name:
                                                                                                    type: string
                                                                                                    nullable: true
                                                                                            nullable: true
                                                                                        body:
                                                                                            type: string
                                                                                            nullable: true
                                                                                        subject:
                                                                                            type: string
                                                                                            nullable: true
                                                                                        url:
                                                                                            type: string
                                                                                            nullable: true
                                                                                    nullable: true
                                                                                origin_repository_url:
                                                                                    type: string
                                                                                    nullable: true
                                                                                provider_name:
                                                                                    type: string
                                                                                    nullable: true
                                                                                revision:
                                                                                    type: string
                                                                                    nullable: true
                                                                                tag:
                                                                                    type: string
                                                                                    nullable: true
                                                                                target_repository_url:
                                                                                    type: string
                                                                                    nullable: true
                                                                            nullable: true
                                                            required:
                                                                - attributes
                                                        pipeline:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        name:
                                                                            type: string
                                                                            nullable: true
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - attributes
                                                                - id
                                                        project:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                        trigger:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        event_source:
                                                                            type: object
                                                                            properties:
                                                                                type:
                                                                                    type: string
                                                                                    nullable: true
                                                                        name:
                                                                            type: string
                                                                            nullable: true
                                                                    required:
                                                                        - event_source
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - attributes
                                                                - id
                                                        user:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                            nullable: true
                                                    required:
                                                        - event
                                                        - pipeline
                                                        - project
                                                        - trigger
                                            required:
                                                - attributes
                                                - id
                                                - references
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        post:
            operationId: post-runs
            tags:
                - Runs
            summary: Fires a run for the pipeline named by pipeline_id, returning the created
            description: run. The optional filter[project_id] scopes the pipeline to a project directly (mirroring Get/Delete); DB-backed pipelines omit it and derive the project from pipeline_id.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                checkout:
                                                    type: object
                                                    properties:
                                                        branch:
                                                            type: string
                                                            nullable: true
                                                        tag:
                                                            type: string
                                                            nullable: true
                                                config:
                                                    type: object
                                                    properties:
                                                        branch:
                                                            type: string
                                                            nullable: true
                                                        tag:
                                                            type: string
                                                            nullable: true
                                                parameters:
                                                    type: string
                                                    nullable: true
                                            required:
                                                - checkout
                                                - config
                                        references:
                                            type: object
                                            properties:
                                                pipeline:
                                                    type: object
                                                    properties:
                                                        id:
                                                            type: string
                                                            format: uuid
                                                    required:
                                                        - id
                                            required:
                                                - pipeline
                                    required:
                                        - attributes
                                        - references
                            required:
                                - data
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    pipeline:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    project:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    user:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - pipeline
                                                    - project
                                                    - user
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/runs/facet-values:
        get:
            operationId: get-runs-facet-values
            tags:
                - Runs
            summary: Returns a paginated list of distinct values for a single run facet within one project.
            description: |-
                EXPERIMENTAL — This endpoint is experimental and may change without notice. Field names, request and response shapes, and pagination semantics are not yet stable. Do not depend on this endpoint in production clients.

                Values are ordered by most-recently-seen (the most recent pipeline that carried the value). Supported facet keys are actor.id, pipeline.status, pipeline.phase, pipeline.current_outcome, and indexed pipeline values (for example pipeline.git.branch).
            parameters:
                - name: filter[facet]
                  in: query
                  required: true
                  schema:
                    type: string
                - name: filter[project_id]
                  in: query
                  required: true
                  schema:
                    type: string
                    format: uuid
                - name: page[cursor]
                  in: query
                  description: Opaque cursor for the next or previous page. Send back the value of page.next or page.prev from a previous response on this operation, verbatim - it is a cursor value, not a URL, and must not be constructed or decoded. Omit for the first page.
                  schema:
                    type: string
                - name: page[limit]
                  in: query
                  description: Maximum items in one page. Out-of-range values are rejected with 400 rather than clamped.
                  schema:
                    type: integer
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        count:
                                                            type: integer
                                                        value:
                                                            type: string
                                                    required:
                                                        - count
                                                        - value
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - attributes
                                                - id
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/runs/facet-values/search:
        post:
            operationId: post-runs-facet-values-search
            tags:
                - Runs
            summary: Returns a paginated list of distinct values for a single run facet across one or more projects.
            description: |-
                EXPERIMENTAL — This endpoint is experimental and may change without notice. Field names, request and response shapes, and pagination semantics are not yet stable. Do not depend on this endpoint in production clients.

                Values are ordered by most-recently-seen (the most recent pipeline that carried the value). Supported facet keys are actor.id, pipeline.status, pipeline.phase, pipeline.current_outcome, and indexed pipeline values (for example pipeline.git.branch).

                The optional filter expression pre-filters which pipelines contribute values (same expression grammar as api/v3/runs/search). The optional matches string is a case-insensitive substring match against the facet values themselves. When scope.from or scope.to are omitted, the same default two-week window used by other v3 search endpoints is applied.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                facet:
                                    type: string
                                filter:
                                    type: string
                                    nullable: true
                                matches:
                                    type: string
                                    nullable: true
                                page:
                                    type: object
                                    properties:
                                        cursor:
                                            type: string
                                        limit:
                                            type: integer
                                    required:
                                        - cursor
                                        - limit
                                scope:
                                    type: object
                                    properties:
                                        from:
                                            type: string
                                            format: date-time
                                        project_ids:
                                            type: array
                                            items:
                                                type: string
                                                format: uuid
                                        to:
                                            type: string
                                            format: date-time
                                    required:
                                        - from
                                        - project_ids
                                        - to
                            required:
                                - facet
                                - page
                                - scope
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        count:
                                                            type: integer
                                                        value:
                                                            type: string
                                                    required:
                                                        - count
                                                        - value
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - attributes
                                                - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/runs/search:
        post:
            operationId: post-runs-search
            tags:
                - Runs
            summary: Search a run.
            description: The optional include field requests nested entities on each run. Allowed values are workflows (truncated nested workflows) and workflows.jobs (workflows plus a truncated nested jobs list per workflow). Unknown values are rejected with 400. When include is omitted or empty, attributes.workflows is omitted from each item. Nested workflow lists are capped at 5 items and nested job lists at 20; is_truncated is true when more exist, and total_count / count_by_phase / count_by_outcome cover the full uncapped set.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                filter:
                                    type: string
                                include:
                                    type: array
                                    items:
                                        type: string
                                    nullable: true
                                order_by:
                                    type: string
                                page:
                                    type: object
                                    properties:
                                        cursor:
                                            type: string
                                        limit:
                                            type: integer
                                    required:
                                        - cursor
                                        - limit
                                scope:
                                    type: object
                                    properties:
                                        from:
                                            type: string
                                            format: date-time
                                        project_ids:
                                            type: array
                                            items:
                                                type: string
                                                format: uuid
                                        to:
                                            type: string
                                            format: date-time
                                    required:
                                        - from
                                        - project_ids
                                        - to
                            required:
                                - filter
                                - order_by
                                - page
                                - scope
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        created_at:
                                                            type: string
                                                            format: date-time
                                                        current_outcome:
                                                            type: string
                                                            nullable: true
                                                        errors:
                                                            type: array
                                                            items:
                                                                type: object
                                                                properties:
                                                                    message:
                                                                        type: string
                                                                    type:
                                                                        type: string
                                                                required:
                                                                    - message
                                                                    - type
                                                            nullable: true
                                                        number:
                                                            type: integer
                                                        phase:
                                                            type: string
                                                        warnings:
                                                            type: array
                                                            items:
                                                                type: object
                                                                properties:
                                                                    message:
                                                                        type: string
                                                                    type:
                                                                        type: string
                                                                required:
                                                                    - message
                                                                    - type
                                                            nullable: true
                                                        workflows:
                                                            type: object
                                                            properties:
                                                                count_by_outcome:
                                                                    type: object
                                                                    additionalProperties:
                                                                        type: integer
                                                                count_by_phase:
                                                                    type: object
                                                                    additionalProperties:
                                                                        type: integer
                                                                is_truncated:
                                                                    type: boolean
                                                                items:
                                                                    type: array
                                                                    items:
                                                                        type: object
                                                                        properties:
                                                                            auto_rerun:
                                                                                type: object
                                                                                properties:
                                                                                    max_reruns:
                                                                                        type: integer
                                                                                    number:
                                                                                        type: integer
                                                                                required:
                                                                                    - max_reruns
                                                                                    - number
                                                                                nullable: true
                                                                            created_at:
                                                                                type: string
                                                                                format: date-time
                                                                                nullable: true
                                                                            current_outcome:
                                                                                type: string
                                                                                nullable: true
                                                                            ended_at:
                                                                                type: string
                                                                                format: date-time
                                                                                nullable: true
                                                                            id:
                                                                                type: string
                                                                                format: uuid
                                                                            jobs:
                                                                                type: object
                                                                                properties:
                                                                                    count_by_outcome:
                                                                                        type: object
                                                                                        additionalProperties:
                                                                                            type: integer
                                                                                    count_by_phase:
                                                                                        type: object
                                                                                        additionalProperties:
                                                                                            type: integer
                                                                                    is_truncated:
                                                                                        type: boolean
                                                                                    items:
                                                                                        type: array
                                                                                        items:
                                                                                            type: object
                                                                                            properties:
                                                                                                ended_at:
                                                                                                    type: string
                                                                                                    format: date-time
                                                                                                    nullable: true
                                                                                                id:
                                                                                                    type: string
                                                                                                    format: uuid
                                                                                                name:
                                                                                                    type: string
                                                                                                    nullable: true
                                                                                                number:
                                                                                                    type: integer
                                                                                                    nullable: true
                                                                                                outcome:
                                                                                                    type: string
                                                                                                    nullable: true
                                                                                                phase:
                                                                                                    type: string
                                                                                                    nullable: true
                                                                                                started_at:
                                                                                                    type: string
                                                                                                    format: date-time
                                                                                                    nullable: true
                                                                                                type:
                                                                                                    type: string
                                                                                                    nullable: true
                                                                                            required:
                                                                                                - id
                                                                                    total_count:
                                                                                        type: integer
                                                                                required:
                                                                                    - count_by_outcome
                                                                                    - count_by_phase
                                                                                    - is_truncated
                                                                                    - items
                                                                                    - total_count
                                                                                nullable: true
                                                                            name:
                                                                                type: string
                                                                                nullable: true
                                                                            outcome:
                                                                                type: string
                                                                                nullable: true
                                                                            phase:
                                                                                type: string
                                                                                nullable: true
                                                                            tag:
                                                                                type: string
                                                                                nullable: true
                                                                        required:
                                                                            - id
                                                                total_count:
                                                                    type: integer
                                                            required:
                                                                - count_by_outcome
                                                                - count_by_phase
                                                                - is_truncated
                                                                - items
                                                                - total_count
                                                            nullable: true
                                                    required:
                                                        - created_at
                                                        - number
                                                        - phase
                                                id:
                                                    type: string
                                                    format: uuid
                                                references:
                                                    type: object
                                                    properties:
                                                        event:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        action:
                                                                            type: string
                                                                            nullable: true
                                                                        type:
                                                                            type: string
                                                                            nullable: true
                                                                        vcs:
                                                                            type: object
                                                                            properties:
                                                                                branch:
                                                                                    type: string
                                                                                    nullable: true
                                                                                commit:
                                                                                    type: object
                                                                                    properties:
                                                                                        author:
                                                                                            type: object
                                                                                            properties:
                                                                                                avatar_url:
                                                                                                    type: string
                                                                                                    nullable: true
                                                                                                login:
                                                                                                    type: string
                                                                                                    nullable: true
                                                                                                name:
                                                                                                    type: string
                                                                                                    nullable: true
                                                                                            nullable: true
                                                                                        body:
                                                                                            type: string
                                                                                            nullable: true
                                                                                        subject:
                                                                                            type: string
                                                                                            nullable: true
                                                                                        url:
                                                                                            type: string
                                                                                            nullable: true
                                                                                    nullable: true
                                                                                origin_repository_url:
                                                                                    type: string
                                                                                    nullable: true
                                                                                provider_name:
                                                                                    type: string
                                                                                    nullable: true
                                                                                revision:
                                                                                    type: string
                                                                                    nullable: true
                                                                                tag:
                                                                                    type: string
                                                                                    nullable: true
                                                                                target_repository_url:
                                                                                    type: string
                                                                                    nullable: true
                                                                            nullable: true
                                                            required:
                                                                - attributes
                                                        pipeline:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        name:
                                                                            type: string
                                                                            nullable: true
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - attributes
                                                                - id
                                                        project:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                        trigger:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties:
                                                                        event_source:
                                                                            type: object
                                                                            properties:
                                                                                type:
                                                                                    type: string
                                                                                    nullable: true
                                                                        name:
                                                                            type: string
                                                                            nullable: true
                                                                    required:
                                                                        - event_source
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - attributes
                                                                - id
                                                        user:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                            nullable: true
                                                    required:
                                                        - event
                                                        - pipeline
                                                        - project
                                                        - trigger
                                            required:
                                                - attributes
                                                - id
                                                - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/runs/{id}:
        get:
            operationId: get-runs-by-id
            tags:
                - Runs
            summary: Retrieve a single run by its ID.
            description: |-
                A run uses current_outcome (not outcome) because reruns can change the outcome at any time, it is never truly final.

                phase: "queued", "started", "ended" current_outcome: "succeeded", "failed", "canceled", "errored", "not_run", "unauthorized"
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                    current_outcome:
                                                        type: string
                                                        nullable: true
                                                    errors:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                message:
                                                                    type: string
                                                                type:
                                                                    type: string
                                                            required:
                                                                - message
                                                                - type
                                                        nullable: true
                                                    number:
                                                        type: integer
                                                    phase:
                                                        type: string
                                                    warnings:
                                                        type: array
                                                        items:
                                                            type: object
                                                            properties:
                                                                message:
                                                                    type: string
                                                                type:
                                                                    type: string
                                                            required:
                                                                - message
                                                                - type
                                                        nullable: true
                                                required:
                                                    - created_at
                                                    - number
                                                    - phase
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    event:
                                                        type: object
                                                        properties:
                                                            attributes:
                                                                type: object
                                                                properties:
                                                                    action:
                                                                        type: string
                                                                        nullable: true
                                                                    type:
                                                                        type: string
                                                                        nullable: true
                                                                    vcs:
                                                                        type: object
                                                                        properties:
                                                                            branch:
                                                                                type: string
                                                                                nullable: true
                                                                            commit:
                                                                                type: object
                                                                                properties:
                                                                                    author:
                                                                                        type: object
                                                                                        properties:
                                                                                            avatar_url:
                                                                                                type: string
                                                                                                nullable: true
                                                                                            login:
                                                                                                type: string
                                                                                                nullable: true
                                                                                            name:
                                                                                                type: string
                                                                                                nullable: true
                                                                                        nullable: true
                                                                                    body:
                                                                                        type: string
                                                                                        nullable: true
                                                                                    subject:
                                                                                        type: string
                                                                                        nullable: true
                                                                                    url:
                                                                                        type: string
                                                                                        nullable: true
                                                                                nullable: true
                                                                            origin_repository_url:
                                                                                type: string
                                                                                nullable: true
                                                                            provider_name:
                                                                                type: string
                                                                                nullable: true
                                                                            revision:
                                                                                type: string
                                                                                nullable: true
                                                                            tag:
                                                                                type: string
                                                                                nullable: true
                                                                            target_repository_url:
                                                                                type: string
                                                                                nullable: true
                                                                        nullable: true
                                                        required:
                                                            - attributes
                                                    pipeline:
                                                        type: object
                                                        properties:
                                                            attributes:
                                                                type: object
                                                                properties:
                                                                    name:
                                                                        type: string
                                                                        nullable: true
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - attributes
                                                            - id
                                                    project:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    trigger:
                                                        type: object
                                                        properties:
                                                            attributes:
                                                                type: object
                                                                properties:
                                                                    event_source:
                                                                        type: object
                                                                        properties:
                                                                            type:
                                                                                type: string
                                                                                nullable: true
                                                                    name:
                                                                        type: string
                                                                        nullable: true
                                                                required:
                                                                    - event_source
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - attributes
                                                            - id
                                                    user:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                        nullable: true
                                                required:
                                                    - event
                                                    - pipeline
                                                    - project
                                                    - trigger
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/sidecar/commands/{id}:
        get:
            operationId: get-sidecar-commands-by-id
            tags:
                - Sidecar Commands
            summary: Retrieve a single sidecar command by its ID.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                    ended_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    exit_code:
                                                        type: integer
                                                        nullable: true
                                                    outcome:
                                                        type: string
                                                        nullable: true
                                                    phase:
                                                        type: string
                                                    pid:
                                                        type: integer
                                                        nullable: true
                                                    started_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                required:
                                                    - created_at
                                                    - phase
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    sidecar_instance:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - sidecar_instance
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                504:
                    description: Sidecar did not respond in time
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
    /api/v3/sidecar/commands/{id}/output:
        get:
            operationId: get-sidecar-commands-by-id-output
            tags:
                - Sidecar Commands
            summary: Streams a command's output as Server-Sent Events.
            description: |-
                Output arrives as stdout and stderr events whose data is the base64 of the raw bytes, so carriage returns, ANSI escapes and invalid UTF-8 reach the client exactly as the command wrote them. A start event opens the stream and : comments keep it warm while a command is silent.

                Every event carries an opaque id. Send the last one back in the Last-Event-ID header to resume precisely where a dropped connection stopped; the stdout_offset and stderr_offset query parameters do the same for callers that cannot set headers. Last-Event-ID wins if both are supplied.

                The stream ends with exactly one exit or error event, or with nothing at all. Nothing at all means the connection was interrupted and the client should resume — it is the only way to distinguish a finished command from a truncated stream.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
                - name: stderr_offset
                  in: query
                  schema:
                    type: string
                - name: stdout_offset
                  in: query
                  schema:
                    type: string
            responses:
                200:
                    description: OK
                400:
                    description: Invalid stdout_offset
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                410:
                    $ref: '#/components/responses/Gone'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                502:
                    description: Could not reach the sidecar
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                504:
                    description: The sidecar stopped responding
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
    /api/v3/sidecar/instances:
        get:
            operationId: get-sidecar-instances
            tags:
                - Sidecar Instances
            summary: List sidecar instances.
            parameters:
                - name: all
                  in: query
                  required: true
                  schema:
                    type: string
            responses:
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        post:
            operationId: post-sidecar-instances
            tags:
                - Sidecar Instances
            summary: Create a new sidecar instance.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                image:
                                                    type: string
                                                name:
                                                    type: string
                                            required:
                                                - image
                                                - name
                                    required:
                                        - attributes
                            required:
                                - data
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    name:
                                                        type: string
                                                required:
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    org:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    user:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - org
                                                    - user
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Name is reserved
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/sidecar/instances/prune:
        post:
            operationId: post-sidecar-instances-prune
            tags:
                - Sidecar Instances
            summary: Deletes caller-owned sidecar instances in orgID.
            description: Instances created before scope.to are deleted; scope.to defaults to now minus 1h when scope is omitted.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                org_id:
                                    type: string
                                    format: uuid
                                scope:
                                    type: object
                                    properties:
                                        to:
                                            type: string
                                            format: date-time
                                    required:
                                        - to
                                    nullable: true
                            required:
                                - org_id
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    deleted_count:
                                                        type: integer
                                                required:
                                                    - deleted_count
                                        required:
                                            - attributes
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/sidecar/instances/{id}:
        get:
            operationId: get-sidecar-instances-by-id
            tags:
                - Sidecar Instances
            summary: Retrieve a single sidecar instance by its ID.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    domain:
                                                        type: string
                                                    name:
                                                        type: string
                                                    phase:
                                                        type: string
                                                        nullable: true
                                                required:
                                                    - domain
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    org:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - org
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        delete:
            operationId: delete-sidecar-instances-by-id
            tags:
                - Sidecar Instances
            summary: Delete a sidecar instance.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                204:
                    description: No Content
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/sidecar/instances/{id}/exec:
        post:
            operationId: post-sidecar-instances-by-id-exec
            tags:
                - Sidecar Instances
            summary: Starts a command asynchronously and returns 202.
            description: Clients poll the command for its outcome and stream its output separately.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                args:
                                    type: array
                                    items:
                                        type: string
                                command:
                                    type: string
                                contexts:
                                    type: array
                                    items:
                                        type: string
                                env:
                                    type: string
                                working_dir:
                                    type: string
                            required:
                                - args
                                - command
                                - contexts
                                - env
                                - working_dir
            responses:
                202:
                    description: Accepted
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    phase:
                                                        type: string
                                                required:
                                                    - phase
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    sidecar_instance:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - sidecar_instance
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                409:
                    description: Sidecar is changing state; try again
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                410:
                    $ref: '#/components/responses/Gone'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                504:
                    description: Sidecar did not respond in time
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
    /api/v3/sidecar/instances/{id}/ssh/add-key:
        post:
            operationId: post-sidecar-instances-by-id-ssh-add-key
            tags:
                - Sidecar Instances
            summary: Adds an ssh key to the instance.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                public_key:
                                    type: string
                            required:
                                - public_key
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    url:
                                                        type: string
                                                required:
                                                    - url
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - attributes
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                409:
                    description: Sidecar is changing state; try again
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                410:
                    $ref: '#/components/responses/Gone'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
                504:
                    description: Sidecar did not respond in time
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
    /api/v3/sidecar/snapshots:
        get:
            operationId: get-sidecar-snapshots
            tags:
                - Sidecar Snapshots
            summary: List sidecar snapshots.
            responses:
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        post:
            operationId: post-sidecar-snapshots
            tags:
                - Sidecar Snapshots
            summary: Create a new sidecar snapshot.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                name:
                                                    type: string
                                                tag:
                                                    type: string
                                                    nullable: true
                                            required:
                                                - name
                                        references:
                                            type: object
                                            properties:
                                                sidecar_instance:
                                                    type: object
                                                    properties:
                                                        attributes:
                                                            nullable: true
                                                        id:
                                                            type: string
                                                            format: uuid
                                                        rel:
                                                            type: string
                                                            nullable: true
                                                    required:
                                                        - id
                                            required:
                                                - sidecar_instance
                                    required:
                                        - attributes
                                        - references
                            required:
                                - data
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    name:
                                                        type: string
                                                    tag:
                                                        type: string
                                                        nullable: true
                                                required:
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    org:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - org
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Name must not exceed 255 characters
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                409:
                    description: A snapshot with that name already exists
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/sidecar/snapshots/{id}:
        get:
            operationId: get-sidecar-snapshots-by-id
            tags:
                - Sidecar Snapshots
            summary: Retrieve a single sidecar snapshot by its ID.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    name:
                                                        type: string
                                                    tag:
                                                        type: string
                                                        nullable: true
                                                required:
                                                    - name
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    org:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - org
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/signing/certificates:
        get:
            operationId: get-signing-certificates
            tags:
                - Signing Certificates
            summary: Lists the iOS signing certificates for an organization.
            parameters:
                - name: filter[org_id]
                  in: query
                  required: true
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        cert_type:
                                                            type: string
                                                        created_at:
                                                            type: string
                                                            format: date-time
                                                            nullable: true
                                                        expires_at:
                                                            type: string
                                                            format: date-time
                                                            nullable: true
                                                        file_name:
                                                            type: string
                                                        fingerprint:
                                                            type: string
                                                    required:
                                                        - cert_type
                                                        - file_name
                                                        - fingerprint
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - attributes
                                                - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        post:
            operationId: post-signing-certificates
            tags:
                - Signing Certificates
            summary: Uploads an iOS signing certificate to an organization.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                cert_blob:
                                                    type: string
                                                cert_password:
                                                    type: string
                                                file_name:
                                                    type: string
                                            required:
                                                - cert_blob
                                                - cert_password
                                                - file_name
                                        references:
                                            type: object
                                            properties:
                                                org:
                                                    type: object
                                                    properties:
                                                        attributes:
                                                            type: string
                                                            nullable: true
                                                        id:
                                                            type: string
                                                            format: uuid
                                                        rel:
                                                            type: string
                                                            nullable: true
                                                    required:
                                                        - id
                                            required:
                                                - org
                                    required:
                                        - attributes
                                        - references
                            required:
                                - data
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/signing/certificates/{id}:
        get:
            operationId: get-signing-certificates-by-id
            tags:
                - Signing Certificates
            summary: Returns a single iOS signing certificate by ID.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    cert_type:
                                                        type: string
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    expires_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    file_name:
                                                        type: string
                                                    fingerprint:
                                                        type: string
                                                required:
                                                    - cert_type
                                                    - file_name
                                                    - fingerprint
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    org:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - org
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        delete:
            operationId: delete-signing-certificates-by-id
            tags:
                - Signing Certificates
            summary: Deletes an iOS signing certificate.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/signing/configs:
        get:
            operationId: get-signing-configs
            tags:
                - Signing Configs
            summary: Lists the iOS signing configurations for an organization.
            parameters:
                - name: filter[org_id]
                  in: query
                  required: true
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        name:
                                                            type: string
                                                        provisioning_profiles:
                                                            type: array
                                                            items:
                                                                type: object
                                                                properties:
                                                                    file_name:
                                                                        type: string
                                                                    id:
                                                                        type: string
                                                                required:
                                                                    - file_name
                                                                    - id
                                                    required:
                                                        - name
                                                        - provisioning_profiles
                                                id:
                                                    type: string
                                                    format: uuid
                                                references:
                                                    type: object
                                                    properties:
                                                        signing_certificate:
                                                            type: object
                                                            properties:
                                                                attributes:
                                                                    type: object
                                                                    properties: {}
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - attributes
                                                                - id
                                                    required:
                                                        - signing_certificate
                                            required:
                                                - attributes
                                                - id
                                                - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        post:
            operationId: post-signing-configs
            tags:
                - Signing Configs
            summary: Creates an iOS signing configuration for an organization.
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                name:
                                                    type: string
                                                provisioning_profiles:
                                                    type: array
                                                    items:
                                                        type: object
                                                        properties:
                                                            blob:
                                                                type: string
                                                            file_name:
                                                                type: string
                                                        required:
                                                            - blob
                                                            - file_name
                                            required:
                                                - name
                                                - provisioning_profiles
                                        references:
                                            type: object
                                            properties:
                                                org:
                                                    type: object
                                                    properties:
                                                        attributes:
                                                            type: string
                                                            nullable: true
                                                        id:
                                                            type: string
                                                            format: uuid
                                                        rel:
                                                            type: string
                                                            nullable: true
                                                    required:
                                                        - id
                                                signing_certificate:
                                                    type: object
                                                    properties:
                                                        attributes:
                                                            type: string
                                                            nullable: true
                                                        id:
                                                            type: string
                                                            format: uuid
                                                        rel:
                                                            type: string
                                                            nullable: true
                                                    required:
                                                        - id
                                            required:
                                                - org
                                                - signing_certificate
                                    required:
                                        - attributes
                                        - references
                            required:
                                - data
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/signing/configs/{id}:
        delete:
            operationId: delete-signing-configs-by-id
            tags:
                - Signing Configs
            summary: Deletes an iOS signing configuration.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/signing/configs/{id}/remove-profile:
        post:
            operationId: post-signing-configs-by-id-remove-profile
            tags:
                - Signing Configs
            summary: Removes a provisioning profile from an iOS signing configuration.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                profile_id:
                                    type: string
                                    format: uuid
                            required:
                                - profile_id
            responses:
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/signing/configs/{id}/update-profile:
        post:
            operationId: post-signing-configs-by-id-update-profile
            tags:
                - Signing Configs
            summary: Updates a provisioning profile in an iOS signing configuration.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                blob:
                                    type: string
                                file_name:
                                    type: string
                            required:
                                - blob
                                - file_name
            responses:
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/tool/releases:
        get:
            operationId: get-tool-releases
            tags:
                - Tool Releases
            summary: List tool releases.
            responses:
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/triggers:
        get:
            operationId: get-triggers
            tags:
                - Triggers
            summary: Lists a project's triggers.
            description: At least one of filter[project_id] or filter[pipeline_id] is required; both may be given to require triggers to match both. The result includes the project's synthetic OAuth trigger whenever it satisfies the supplied filters (a list not scoped by pipeline, or a filter[pipeline_id] pointing at the synthetic pipeline). A synthetic pipeline id cannot be resolved from the id alone, so a pipeline-only request for it returns 404; supply project_id to surface the synthetic trigger.
            parameters:
                - name: filter[pipeline_id]
                  in: query
                  schema:
                    type: string
                    format: uuid
                - name: filter[project_id]
                  in: query
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        post:
            operationId: post-triggers
            tags:
                - Triggers
            summary: Creates a trigger under the pipeline named by pipeline_id.
            description: Returns the full created entity (shape-identical to Get, plus the one-time webhook secret).
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                checkout:
                                                    type: object
                                                    properties:
                                                        ref:
                                                            type: string
                                                            nullable: true
                                                config:
                                                    type: object
                                                    properties:
                                                        ref:
                                                            type: string
                                                            nullable: true
                                                event:
                                                    type: object
                                                    properties:
                                                        filter:
                                                            type: object
                                                            properties:
                                                                preset:
                                                                    type: string
                                                                    nullable: true
                                                                rules:
                                                                    type: array
                                                                    items:
                                                                        type: object
                                                                        properties:
                                                                            event_ref:
                                                                                type: string
                                                                                nullable: true
                                                                            event_type:
                                                                                type: string
                                                                                nullable: true
                                                                            rule:
                                                                                type: string
                                                                        required:
                                                                            - rule
                                                            required:
                                                                - rules
                                                        schedule:
                                                            type: array
                                                            items:
                                                                type: integer
                                                            nullable: true
                                                        type:
                                                            type: string
                                                        vcs:
                                                            type: object
                                                            properties:
                                                                provider:
                                                                    type: string
                                                                repo_full_name:
                                                                    type: string
                                                                repo_id:
                                                                    type: string
                                                            required:
                                                                - provider
                                                                - repo_full_name
                                                                - repo_id
                                                        webhook:
                                                            type: object
                                                            properties:
                                                                name:
                                                                    type: string
                                                                    nullable: true
                                                                secret:
                                                                    type: string
                                                                    nullable: true
                                                                source:
                                                                    type: string
                                                                    nullable: true
                                                    required:
                                                        - filter
                                                        - type
                                                        - vcs
                                                        - webhook
                                                is_disabled:
                                                    type: boolean
                                            required:
                                                - checkout
                                                - config
                                                - event
                                                - is_disabled
                                        references:
                                            type: object
                                            properties:
                                                pipeline:
                                                    type: object
                                                    properties:
                                                        id:
                                                            type: string
                                                            format: uuid
                                                    required:
                                                        - id
                                            required:
                                                - pipeline
                                    required:
                                        - attributes
                                        - references
                            required:
                                - data
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    checkout:
                                                        type: object
                                                        properties:
                                                            ref:
                                                                type: string
                                                                nullable: true
                                                    config:
                                                        type: object
                                                        properties:
                                                            ref:
                                                                type: string
                                                                nullable: true
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    event:
                                                        type: object
                                                        properties:
                                                            filter:
                                                                type: object
                                                                properties:
                                                                    preset:
                                                                        type: string
                                                                        nullable: true
                                                                    rules:
                                                                        type: array
                                                                        items:
                                                                            type: object
                                                                            properties:
                                                                                event_ref:
                                                                                    type: string
                                                                                    nullable: true
                                                                                event_type:
                                                                                    type: string
                                                                                    nullable: true
                                                                                rule:
                                                                                    type: string
                                                                            required:
                                                                                - rule
                                                                required:
                                                                    - rules
                                                            schedule:
                                                                type: array
                                                                items:
                                                                    type: integer
                                                                nullable: true
                                                            type:
                                                                type: string
                                                            vcs:
                                                                type: object
                                                                properties:
                                                                    provider:
                                                                        type: string
                                                                    repo_full_name:
                                                                        type: string
                                                                        nullable: true
                                                                    repo_id:
                                                                        type: string
                                                                        nullable: true
                                                                required:
                                                                    - provider
                                                            webhook:
                                                                type: object
                                                                properties:
                                                                    name:
                                                                        type: string
                                                                        nullable: true
                                                                    secret:
                                                                        type: string
                                                                        nullable: true
                                                                    source:
                                                                        type: string
                                                                        nullable: true
                                                        required:
                                                            - filter
                                                            - type
                                                            - vcs
                                                            - webhook
                                                    is_disabled:
                                                        type: boolean
                                                required:
                                                    - checkout
                                                    - config
                                                    - event
                                                    - is_disabled
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    pipeline:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    project:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - pipeline
                                                    - project
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/triggers/{id}:
        get:
            operationId: get-triggers-by-id
            tags:
                - Triggers
            summary: Gets a trigger by ID.
            description: The optional filter[project_id] query parameter scopes the lookup; it is required to resolve synthetic OAuth triggers, which have no stored row and are derived from the project.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    checkout:
                                                        type: object
                                                        properties:
                                                            ref:
                                                                type: string
                                                                nullable: true
                                                    config:
                                                        type: object
                                                        properties:
                                                            ref:
                                                                type: string
                                                                nullable: true
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    event:
                                                        type: object
                                                        properties:
                                                            filter:
                                                                type: object
                                                                properties:
                                                                    preset:
                                                                        type: string
                                                                        nullable: true
                                                                    rules:
                                                                        type: array
                                                                        items:
                                                                            type: object
                                                                            properties:
                                                                                event_ref:
                                                                                    type: string
                                                                                    nullable: true
                                                                                event_type:
                                                                                    type: string
                                                                                    nullable: true
                                                                                rule:
                                                                                    type: string
                                                                            required:
                                                                                - rule
                                                                required:
                                                                    - rules
                                                            schedule:
                                                                type: array
                                                                items:
                                                                    type: integer
                                                                nullable: true
                                                            type:
                                                                type: string
                                                            vcs:
                                                                type: object
                                                                properties:
                                                                    provider:
                                                                        type: string
                                                                    repo_full_name:
                                                                        type: string
                                                                        nullable: true
                                                                    repo_id:
                                                                        type: string
                                                                        nullable: true
                                                                required:
                                                                    - provider
                                                            webhook:
                                                                type: object
                                                                properties:
                                                                    name:
                                                                        type: string
                                                                        nullable: true
                                                                    secret:
                                                                        type: string
                                                                        nullable: true
                                                                    source:
                                                                        type: string
                                                                        nullable: true
                                                        required:
                                                            - filter
                                                            - type
                                                            - vcs
                                                            - webhook
                                                    is_disabled:
                                                        type: boolean
                                                required:
                                                    - checkout
                                                    - config
                                                    - event
                                                    - is_disabled
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    pipeline:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    project:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - pipeline
                                                    - project
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
        delete:
            operationId: delete-triggers-by-id
            tags:
                - Triggers
            summary: Deletes a trigger by ID.
            description: The optional filter[project_id] query parameter scopes the lookup; it is required to resolve synthetic OAuth triggers, which have no stored row and are derived from the project.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/triggers/{id}/update:
        post:
            operationId: post-triggers-by-id-update
            tags:
                - Triggers
            summary: Partially updates a trigger by ID.
            description: The optional filter[project_id] query parameter scopes the lookup; it is required to resolve synthetic OAuth triggers.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                checkout:
                                    type: object
                                    properties:
                                        ref:
                                            type: string
                                            nullable: true
                                config:
                                    type: object
                                    properties:
                                        ref:
                                            type: string
                                            nullable: true
                                event:
                                    type: object
                                    properties:
                                        filter:
                                            type: object
                                            properties:
                                                preset:
                                                    type: string
                                                    nullable: true
                                                rules:
                                                    type: array
                                                    items:
                                                        type: object
                                                        properties:
                                                            event_ref:
                                                                type: string
                                                                nullable: true
                                                            event_type:
                                                                type: string
                                                                nullable: true
                                                            rule:
                                                                type: string
                                                        required:
                                                            - rule
                                            required:
                                                - rules
                                        schedule:
                                            type: array
                                            items:
                                                type: integer
                                            nullable: true
                                        webhook:
                                            type: object
                                            properties:
                                                name:
                                                    type: string
                                                    nullable: true
                                                secret:
                                                    type: string
                                                    nullable: true
                                                source:
                                                    type: string
                                                    nullable: true
                                    required:
                                        - filter
                                        - webhook
                                is_disabled:
                                    type: boolean
                                    nullable: true
                            required:
                                - checkout
                                - config
                                - event
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    checkout:
                                                        type: object
                                                        properties:
                                                            ref:
                                                                type: string
                                                                nullable: true
                                                    config:
                                                        type: object
                                                        properties:
                                                            ref:
                                                                type: string
                                                                nullable: true
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    event:
                                                        type: object
                                                        properties:
                                                            filter:
                                                                type: object
                                                                properties:
                                                                    preset:
                                                                        type: string
                                                                        nullable: true
                                                                    rules:
                                                                        type: array
                                                                        items:
                                                                            type: object
                                                                            properties:
                                                                                event_ref:
                                                                                    type: string
                                                                                    nullable: true
                                                                                event_type:
                                                                                    type: string
                                                                                    nullable: true
                                                                                rule:
                                                                                    type: string
                                                                            required:
                                                                                - rule
                                                                required:
                                                                    - rules
                                                            schedule:
                                                                type: array
                                                                items:
                                                                    type: integer
                                                                nullable: true
                                                            type:
                                                                type: string
                                                            vcs:
                                                                type: object
                                                                properties:
                                                                    provider:
                                                                        type: string
                                                                    repo_full_name:
                                                                        type: string
                                                                        nullable: true
                                                                    repo_id:
                                                                        type: string
                                                                        nullable: true
                                                                required:
                                                                    - provider
                                                            webhook:
                                                                type: object
                                                                properties:
                                                                    name:
                                                                        type: string
                                                                        nullable: true
                                                                    secret:
                                                                        type: string
                                                                        nullable: true
                                                                    source:
                                                                        type: string
                                                                        nullable: true
                                                        required:
                                                            - filter
                                                            - type
                                                            - vcs
                                                            - webhook
                                                    is_disabled:
                                                        type: boolean
                                                required:
                                                    - checkout
                                                    - config
                                                    - event
                                                    - is_disabled
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    pipeline:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    project:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - pipeline
                                                    - project
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/usage/exports:
        post:
            operationId: post-usage-exports
            tags:
                - Usage
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                data:
                                    type: object
                                    properties:
                                        attributes:
                                            type: object
                                            properties:
                                                from:
                                                    type: string
                                                    format: date-time
                                                to:
                                                    type: string
                                                    format: date-time
                                            required:
                                                - from
                                                - to
                                        references:
                                            type: object
                                            properties:
                                                child_orgs:
                                                    type: array
                                                    items:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                parent_org:
                                                    type: object
                                                    properties:
                                                        id:
                                                            type: string
                                                            format: uuid
                                                    required:
                                                        - id
                                            required:
                                                - child_orgs
                                                - parent_org
                                    required:
                                        - attributes
                                        - references
                            required:
                                - data
            responses:
                202:
                    description: Accepted
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    download_urls:
                                                        type: array
                                                        items:
                                                            type: string
                                                        nullable: true
                                                    outcome:
                                                        type: string
                                                        nullable: true
                                                    phase:
                                                        type: string
                                                required:
                                                    - phase
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    org:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - org
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/usage/exports/{id}:
        get:
            operationId: get-usage-exports-by-id
            tags:
                - Usage
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    download_urls:
                                                        type: array
                                                        items:
                                                            type: string
                                                        nullable: true
                                                    outcome:
                                                        type: string
                                                        nullable: true
                                                    phase:
                                                        type: string
                                                required:
                                                    - phase
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    org:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                required:
                                                    - org
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/users:
        get:
            operationId: get-users
            tags:
                - Users
            summary: Returns a list of users limited by filter query parameters.
            description: Only filter[user_id]=me is supported currently - returning a single-element collection for the authenticated identity.
            parameters:
                - name: filter[user_id]
                  in: query
                  required: true
                  schema:
                    type: string
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        avatar_url:
                                                            type: string
                                                        login:
                                                            type: string
                                                        name:
                                                            type: string
                                                            nullable: true
                                                    required:
                                                        - avatar_url
                                                        - login
                                                id:
                                                    type: string
                                                    format: uuid
                                            required:
                                                - attributes
                                                - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/workflows:
        get:
            operationId: get-workflows
            tags:
                - Workflows
            summary: Lists the workflows in a run.
            description: 'V2: GET /pipelines/:id/workflows'
            parameters:
                - name: filter[run_id]
                  in: query
                  required: true
                  schema:
                    type: string
                    format: uuid
                - name: page[cursor]
                  in: query
                  description: Opaque cursor for the next or previous page. Send back the value of page.next or page.prev from a previous response on this operation, verbatim - it is a cursor value, not a URL, and must not be constructed or decoded. Omit for the first page.
                  schema:
                    type: string
                - name: page[limit]
                  in: query
                  description: Maximum items in one page. Out-of-range values are rejected with 400 rather than clamped.
                  schema:
                    type: integer
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: array
                                        items:
                                            type: object
                                            properties:
                                                attributes:
                                                    type: object
                                                    properties:
                                                        auto_rerun:
                                                            type: object
                                                            properties:
                                                                max_reruns:
                                                                    type: integer
                                                                number:
                                                                    type: integer
                                                            required:
                                                                - max_reruns
                                                                - number
                                                            nullable: true
                                                        created_at:
                                                            type: string
                                                            format: date-time
                                                            nullable: true
                                                        current_outcome:
                                                            type: string
                                                            nullable: true
                                                        ended_at:
                                                            type: string
                                                            format: date-time
                                                            nullable: true
                                                        name:
                                                            type: string
                                                        outcome:
                                                            type: string
                                                            nullable: true
                                                        phase:
                                                            type: string
                                                        tag:
                                                            type: string
                                                            nullable: true
                                                    required:
                                                        - name
                                                        - phase
                                                id:
                                                    type: string
                                                    format: uuid
                                                references:
                                                    type: object
                                                    properties:
                                                        project:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                        run:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                        user:
                                                            type: object
                                                            properties:
                                                                id:
                                                                    type: string
                                                                    format: uuid
                                                            required:
                                                                - id
                                                            nullable: true
                                                    required:
                                                        - project
                                                        - run
                                            required:
                                                - attributes
                                                - id
                                                - references
                                    page:
                                        type: object
                                        properties:
                                            next:
                                                type: string
                                                nullable: true
                                            prev:
                                                type: string
                                                nullable: true
                                required:
                                    - data
                                    - page
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/workflows/{id}:
        get:
            operationId: get-workflows-by-id
            tags:
                - Workflows
            summary: Retrieve a single workflow by its ID.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                200:
                    description: OK
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            attributes:
                                                type: object
                                                properties:
                                                    auto_rerun:
                                                        type: object
                                                        properties:
                                                            max_reruns:
                                                                type: integer
                                                            number:
                                                                type: integer
                                                        required:
                                                            - max_reruns
                                                            - number
                                                        nullable: true
                                                    created_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    current_outcome:
                                                        type: string
                                                        nullable: true
                                                    ended_at:
                                                        type: string
                                                        format: date-time
                                                        nullable: true
                                                    name:
                                                        type: string
                                                    outcome:
                                                        type: string
                                                        nullable: true
                                                    phase:
                                                        type: string
                                                    tag:
                                                        type: string
                                                        nullable: true
                                                required:
                                                    - name
                                                    - phase
                                            id:
                                                type: string
                                                format: uuid
                                            references:
                                                type: object
                                                properties:
                                                    project:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    run:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                    user:
                                                        type: object
                                                        properties:
                                                            id:
                                                                type: string
                                                                format: uuid
                                                        required:
                                                            - id
                                                        nullable: true
                                                required:
                                                    - project
                                                    - run
                                        required:
                                            - attributes
                                            - id
                                            - references
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/workflows/{id}/cancel:
        post:
            operationId: post-workflows-by-id-cancel
            tags:
                - Workflows
            summary: Requests cancellation of a workflow.
            description: Cancellation is processed asynchronously, so the endpoint returns 202 Accepted with the workflow's id rather than a representation of its final state.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            responses:
                202:
                    description: Accepted
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
    /api/v3/workflows/{id}/rerun:
        post:
            operationId: post-workflows-by-id-rerun
            tags:
                - Workflows
            summary: Reruns an existing workflow, creating and returning a new workflow.
            description: By default every job is rerun; set is_from_failed to rerun only the failed jobs and their dependents. The source workflow is not modified.
            parameters:
                - name: id
                  in: path
                  required: true
                  description: The id.
                  schema:
                    type: string
                    format: uuid
            requestBody:
                required: true
                content:
                    application/json:
                        schema:
                            type: object
                            properties:
                                is_from_failed:
                                    type: boolean
                                    nullable: true
                                is_sparse_tree:
                                    type: boolean
                                    nullable: true
                                is_ssh_enabled:
                                    type: boolean
                                    nullable: true
                                jobs:
                                    type: array
                                    items:
                                        type: string
                                        format: uuid
                                    nullable: true
            responses:
                201:
                    description: Created
                    content:
                        application/json:
                            schema:
                                type: object
                                properties:
                                    data:
                                        type: object
                                        properties:
                                            id:
                                                type: string
                                                format: uuid
                                        required:
                                            - id
                                required:
                                    - data
                400:
                    description: Bad Request
                    content:
                        application/json:
                            schema:
                                type: object
                                required:
                                    - error
                                properties:
                                    error:
                                        $ref: '#/components/schemas/Error'
                401:
                    $ref: '#/components/responses/Unauthorized'
                403:
                    $ref: '#/components/responses/Forbidden'
                404:
                    $ref: '#/components/responses/NotFound'
                429:
                    $ref: '#/components/responses/TooManyRequests'
                500:
                    $ref: '#/components/responses/InternalError'
components:
    securitySchemes:
        bearer_token:
            scheme: bearer
            type: http
    responses:
        Forbidden:
            description: Forbidden - authenticated but not permitted to perform this action. Do not retry.
            content:
                application/json:
                    schema:
                        type: object
                        required:
                            - error
                        properties:
                            error:
                                $ref: '#/components/schemas/Error'
        Gone:
            description: Gone - endpoint permanently removed. Do not retry; migrate to the documented replacement.
            content:
                application/json:
                    schema:
                        type: object
                        required:
                            - error
                        properties:
                            error:
                                $ref: '#/components/schemas/Error'
        InternalError:
            description: Internal server error. Safe to retry with backoff; quote error.id when reporting it.
            content:
                application/json:
                    schema:
                        type: object
                        required:
                            - error
                        properties:
                            error:
                                $ref: '#/components/schemas/Error'
        NotFound:
            description: Not found - the resource does not exist, or the caller is not entitled to know that it does.
            content:
                application/json:
                    schema:
                        type: object
                        required:
                            - error
                        properties:
                            error:
                                $ref: '#/components/schemas/Error'
        TooManyRequests:
            description: Too many requests - rate limited. Wait the Retry-After header's seconds, then retry with backoff.
            content:
                application/json:
                    schema:
                        type: object
                        required:
                            - error
                        properties:
                            error:
                                $ref: '#/components/schemas/Error'
        Unauthorized:
            description: Unauthorized - missing, invalid or expired token. Do not retry without a new token.
            content:
                application/json:
                    schema:
                        type: object
                        required:
                            - error
                        properties:
                            error:
                                $ref: '#/components/schemas/Error'
    schemas:
        Error:
            properties:
                detail:
                    description: Human-readable explanation specific to this occurrence.
                    type: string
                id:
                    description: Unique identifier for this occurrence. Include it when reporting the problem so support can find the failure.
                    type: string
                source:
                    description: Identifies the origin of the error in the request.
                    properties:
                        error:
                            description: Underlying parser/validation error message.
                            type: string
                        offset:
                            description: Byte offset in the JSON input where the error was detected.
                            format: int64
                            type: integer
                        pointer:
                            description: JSON Pointer (RFC 6901) to the field that caused the error.
                            type: string
                    type: object
                title:
                    description: Short, human-readable summary of the problem.
                    type: string
                type:
                    description: 'Low-cardinality machine-readable error type, present only where an operation sets one explicitly - absent is normal, so branch on the HTTP status first and use this to tell causes apart within one status. A bare token, never a URI to dereference. The value set is open, so treat an unrecognised value as a generic failure for the status. Request-parsing errors use: syntax_error, empty_input, unknown_field, invalid_structure, invalid_format, type_mismatch, validation_error, invalid_route, invalid_path_param.'
                    type: string
            type: object
