GitHub Actions · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitHub Actions Cache API

5 actions 5 updates phrasing extends openapi/github-actions-cache-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/caches'].get
$.paths['/repos/{owner}/{repo}/actions/caches'].delete
$.paths['/repos/{owner}/{repo}/actions/caches/{cache_id}'].delete
$.paths['/repos/{owner}/{repo}/actions/cache/usage'].get

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 Cache API
  version: 1.0.0
extends: openapi/github-actions-cache-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/caches'].get
  update:
    x-apievangelist-phrasing:
      intent: List a repository's Actions caches
      effect: read
      questions:
      - What dependency caches are my GitHub Actions workflows keeping for this repo?
      - Can I see only the caches created for a particular branch ref?
      - Which caches match a given key, sorted by size or last use?
      instructions:
      - text: List the Actions caches in {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Show caches in {owner}/{repo} for ref {ref}.
        slots:
          owner: path.owner
          repo: path.repo
          ref: query.ref
      - text: List caches whose key starts with {key}, sorted by {sort}.
        slots:
          key: query.key
          sort: query.sort
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/caches'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete caches matching a full cache key
      effect: destructive
      questions:
      - How do I clear every cache entry that has a specific key?
      - Can I purge a cache key on just one branch ref?
      instructions:
      - text: Delete all caches with key {key} in {owner}/{repo}.
        slots:
          key: query.key
          owner: path.owner
          repo: path.repo
      - text: Purge the cache key {key} only for ref {ref}.
        slots:
          key: query.key
          ref: query.ref
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/caches/{cache_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one Actions cache by its ID
      effect: destructive
      questions:
      - Can I delete a single cache entry when I know its cache ID?
      - How do I remove one specific corrupted cache instead of every cache with that key?
      instructions:
      - text: Delete cache {cache_id} from {owner}/{repo}.
        slots:
          cache_id: path.cache_id
          owner: path.owner
          repo: path.repo
      - text: Remove the single cache entry with ID {cache_id}.
        slots:
          cache_id: path.cache_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/repos/{owner}/{repo}/actions/cache/usage'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a repository's Actions cache usage
      effect: read
      questions:
      - How much cache storage is my repository using in GitHub Actions?
      - How many active caches does this repo have right now?
      instructions:
      - text: Show the total Actions cache usage for {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Tell me how close {owner}/{repo} is to its cache storage limit.
        slots:
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-26'