GitHub Actions · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitHub Actions Artifacts API

6 actions 6 updates phrasing extends openapi/github-actions-artifacts-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/artifacts'].get

$.paths['/repos/{owner}/{repo}/actions/artifacts/{artifact_id}'].get

$.paths['/repos/{owner}/{repo}/actions/artifacts/{artifact_id}'].delete

$.paths['/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}'].get

$.paths['/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts'].get

OpenAPI Overlay

# 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 Artifacts API
  version: 1.0.0
extends: openapi/github-actions-artifacts-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/artifacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List build artifacts across a repository
      effect: read
      questions:
      - What build artifacts are stored across all the workflow runs in my repository?
      - Can I find repository artifacts by name without knowing which run produced them?
      - Which GitHub Actions artifacts is my repo currently keeping?
      instructions:
      - text: List every artifact stored in {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Find artifacts named {name} anywhere in {owner}/{repo}.
        slots:
          name: query.name
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/artifacts/{artifact_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one workflow artifact
      effect: read
      questions:
      - How big is a specific artifact and when does it expire?
      - Can I see the details of one artifact if I have its ID?
      instructions:
      - text: Show me the details of artifact {artifact_id} in {owner}/{repo}.
        slots:
          artifact_id: path.artifact_id
          owner: path.owner
          repo: path.repo
      - text: Check whether artifact {artifact_id} has expired.
        slots:
          artifact_id: path.artifact_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/artifacts/{artifact_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a workflow artifact
      effect: destructive
      questions:
      - How do I remove an old build artifact to free up Actions storage?
      - Can I delete a single artifact without deleting the workflow run that made it?
      instructions:
      - text: Delete artifact {artifact_id} from {owner}/{repo}.
        slots:
          artifact_id: path.artifact_id
          owner: path.owner
          repo: path.repo
      - text: Remove the stored artifact {artifact_id}, it is no longer needed.
        slots:
          artifact_id: path.artifact_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download an artifact as a zip archive
      effect: read
      questions:
      - How do I download the files a workflow uploaded as an artifact?
      - What archive format can I get an artifact in?
      instructions:
      - text: Get the {archive_format} download link for artifact {artifact_id} in {owner}/{repo}.
        slots:
          archive_format: path.archive_format
          artifact_id: path.artifact_id
          owner: path.owner
          repo: path.repo
      - text: Download artifact {artifact_id} as a zip.
        slots:
          artifact_id: path.artifact_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts'].get
  update:
    x-apievangelist-phrasing:
      intent: List the artifacts produced by one workflow run
      effect: read
      questions:
      - What artifacts did a particular workflow run upload?
      - Can I filter one run's artifacts down to a single artifact name?
      instructions:
      - text: List the artifacts uploaded by run {run_id} in {owner}/{repo}.
        slots:
          run_id: path.run_id
          owner: path.owner
          repo: path.repo
      - text: Find the artifact called {name} from workflow run {run_id}.
        slots:
          name: query.name
          run_id: path.run_id
      method: generated
      generated: '2026-09-26'