GitHub Actions · OpenAPI Overlay 1.0.0

API Evangelist enhancements for GitHub Actions OIDC API

5 actions 5 updates update extends openapi/github-actions-oidc-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for GitHub Actions's API. It is a proposal applied on top of the contract, not a document GitHub Actions publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-providerx-apievangelist-artifactsx-github-api-version-headerx-github-default-api-versionx-github-media-typex-idempotencyx-dry-runx-rate-limit-headers

Targets 4

$.info
$.servers[0]
$.components.securitySchemes
$.paths

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for GitHub Actions OIDC API
  version: 1.0.1
  x-generated: '2026-09-17'
  x-method: generated
  x-source: >-
    Generated from openapi/github-actions-oidc-api-openapi.yml plus the artifacts in this repo. Captures the
    runtime semantics the OpenAPI does not express — versioning header, media
    type, rate-limit and request-id headers, token types, the absence of an
    idempotency mechanism, and the reversibility of each write operation. The
    original specification is never mutated.
extends: openapi/github-actions-oidc-api-openapi.yml
actions:
  - target: $.info
    update:
      x-apievangelist-provider: github-actions
      x-apievangelist-artifacts:
        conventions: conventions/github-actions-conventions.yml
        authentication: authentication/github-actions-authentication.yml
        scopes: scopes/github-actions-scopes.yml
        errors: errors/github-actions-error-codes.yml
        lifecycle: lifecycle/github-actions-lifecycle.yml
        rate_limits: rate-limits/github-actions-rate-limits.yml
        plans: plans/github-actions-plans-pricing.yml
        data_model: data-model/github-actions-data-model.yml
        webhooks: asyncapi/github-actions-webhooks.yml
        mcp: mcp/github-actions-mcp.yml
        tool_crosswalk: mcp/github-actions-tool-crosswalk.yml
        skills: skills/_index.yml
  - target: $.info
    update:
      x-github-api-version-header: X-GitHub-Api-Version
      x-github-default-api-version: '2022-11-28'
      x-github-media-type: application/vnd.github+json
      x-idempotency:
        supported: false
        coverage: none
        note: No Idempotency-Key header exists on this API; POST operations are not replay-safe.
      x-dry-run:
        supported: false
  - target: $.servers[0]
    update:
      x-rate-limit-headers:
        - x-ratelimit-limit
        - x-ratelimit-remaining
        - x-ratelimit-used
        - x-ratelimit-reset
        - x-ratelimit-resource
      x-request-id-header: X-GitHub-Request-Id
      x-rate-limit-detail: rate-limits/github-actions-rate-limits.yml
  - target: $.components.securitySchemes
    update:
      x-token-types:
        - fine-grained-pat
        - classic-pat
        - oauth-user-token
        - github-app-installation-token
        - github-actions-job-token
  - target: $.paths
    update:
      x-reversibility:
        setCustomOidcSubClaimForRepo:
          operation: PUT /repos/{owner}/{repo}/actions/oidc/customization/sub
          reversal: setCustomOidcSubClaimForRepo
          window: "unbounded \u2014 read getCustomOidcSubClaimForRepo first"
        setCustomOidcSubClaimForOrg:
          operation: PUT /orgs/{org}/actions/oidc/customization/sub
          reversal: setCustomOidcSubClaimForOrg
          window: "unbounded \u2014 read getCustomOidcSubClaimForOrg first"