GitHub Actions · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitHub Actions Variables API

6 actions 6 updates phrasing extends openapi/github-actions-variables-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 6

$.info
$.paths['/repos/{owner}/{repo}/actions/variables'].get
$.paths['/repos/{owner}/{repo}/actions/variables'].post
$.paths['/repos/{owner}/{repo}/actions/variables/{name}'].get
$.paths['/repos/{owner}/{repo}/actions/variables/{name}'].delete
$.paths['/repos/{owner}/{repo}/actions/variables/{name}'].patch

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 Variables API
  version: 1.0.0
extends: openapi/github-actions-variables-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: 5
- target: $.paths['/repos/{owner}/{repo}/actions/variables'].get
  update:
    x-apievangelist-phrasing:
      intent: List a repository's Actions variables
      effect: read
      questions:
      - What configuration variables are defined for my repository's workflows?
      - Can I see the values of all repo variables at once?
      instructions:
      - text: List the Actions variables in {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Show every configuration variable and its value for {repo}.
        slots:
          repo: path.repo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/variables'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a repository variable
      effect: write
      questions:
      - How do I add a new non-secret variable that my workflows can reference with vars?
      - Can I define a new configuration value for a repository without making it a secret?
      instructions:
      - text: Create variable {name} with value {value} in {owner}/{repo}.
        slots:
          name: requestBody.name
          value: requestBody.value
          owner: path.owner
          repo: path.repo
      - text: Add a new repo variable {name} set to {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/variables/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Read one repository variable
      effect: read
      questions:
      - What is the current value of a specific repository variable?
      - When was a given repo variable last updated?
      instructions:
      - text: Get variable {name} from {owner}/{repo}.
        slots:
          name: path.name
          owner: path.owner
          repo: path.repo
      - text: Tell me the value of repo variable {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/variables/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a repository variable
      effect: destructive
      questions:
      - How do I remove a variable my workflows no longer use?
      - Can I delete a repository variable by its name?
      instructions:
      - text: Delete variable {name} from {owner}/{repo}.
        slots:
          name: path.name
          owner: path.owner
          repo: path.repo
      - text: Remove the repo variable {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/variables/{name}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing repository variable
      effect: write
      questions:
      - How do I change the value of a variable that already exists in my repo?
      - Can I rename an existing repository variable?
      instructions:
      - text: Update existing variable {name} in {owner}/{repo} to value {value}.
        slots:
          name: path.name
          owner: path.owner
          repo: path.repo
          value: requestBody.value
      - text: Change the value of the existing repo variable {name} to {value}.
        slots:
          name: path.name
          value: requestBody.value
      method: generated
      generated: '2026-09-26'