GitHub Actions · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitHub Actions OIDC API

5 actions 5 updates phrasing 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-phrasing

Targets 5

$.info
$.paths['/repos/{owner}/{repo}/actions/oidc/customization/sub'].get
$.paths['/repos/{owner}/{repo}/actions/oidc/customization/sub'].put
$.paths['/orgs/{org}/actions/oidc/customization/sub'].get
$.paths['/orgs/{org}/actions/oidc/customization/sub'].put

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for GitHub Actions OIDC API
  version: 1.0.0
extends: openapi/github-actions-oidc-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/repos/{owner}/{repo}/actions/oidc/customization/sub'].get
  update:
    x-apievangelist-phrasing:
      intent: View a repository's OIDC subject claim template
      effect: read
      questions:
      - What does the OIDC subject claim look like for tokens issued to my repository's workflows?
      - Is my repo using the default OIDC sub claim or a customized one?
      instructions:
      - text: Show the OIDC subject claim template for {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Check whether {owner}/{repo} overrides the default OIDC sub claim.
        slots:
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/oidc/customization/sub'].put
  update:
    x-apievangelist-phrasing:
      intent: Customize a repository's OIDC subject claim
      effect: write
      questions:
      - How do I change which claims go into the OIDC sub for one repository?
      - Can a repository go back to the default OIDC subject claim template?
      instructions:
      - text: Set the OIDC sub claim for {owner}/{repo} to include {include_claim_keys}.
        slots:
          owner: path.owner
          repo: path.repo
          include_claim_keys: requestBody.include_claim_keys
      - text: 'Make {owner}/{repo} use the default OIDC subject template: use_default {use_default}.'
        slots:
          owner: path.owner
          repo: path.repo
          use_default: requestBody.use_default
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org}/actions/oidc/customization/sub'].get
  update:
    x-apievangelist-phrasing:
      intent: View an organization's OIDC subject claim template
      effect: read
      questions:
      - Which claim keys does my organization put into the OIDC subject claim?
      - What OIDC sub template applies across the whole org?
      instructions:
      - text: Show the org-wide OIDC subject claim template for {org}.
        slots:
          org: path.org
      - text: List the claim keys in the {org} organization's OIDC sub template.
        slots:
          org: path.org
      method: generated
      generated: '2026-09-26'
- target: $.paths['/orgs/{org}/actions/oidc/customization/sub'].put
  update:
    x-apievangelist-phrasing:
      intent: Customize an organization's OIDC subject claim
      effect: write
      questions:
      - How do I set a custom OIDC subject claim for every repository in my organization?
      - Can I add claims like the repository owner or environment to the org's OIDC sub?
      instructions:
      - text: Set the {org} organization's OIDC sub claim to include {include_claim_keys}.
        slots:
          org: path.org
          include_claim_keys: requestBody.include_claim_keys
      - text: Update the org-level OIDC subject template for {org}.
        slots:
          org: path.org
      method: generated
      generated: '2026-09-26'