GitHub · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitHub v3 REST Packages API

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

What the actions change

x-apievangelist-phrasing

Targets 28 · first 16 shown; the file carries all of them

$.info
$.paths['/orgs/{org}/docker/conflicts'].get
$.paths['/orgs/{org}/packages'].get
$.paths['/orgs/{org}/packages/{package_type}/{package_name}'].get
$.paths['/orgs/{org}/packages/{package_type}/{package_name}'].delete
$.paths['/orgs/{org}/packages/{package_type}/{package_name}/restore'].post
$.paths['/orgs/{org}/packages/{package_type}/{package_name}/versions'].get
$.paths['/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}'].get
$.paths['/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}'].delete
$.paths['/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore'].post
$.paths['/user/docker/conflicts'].get
$.paths['/user/packages'].get
$.paths['/user/packages/{package_type}/{package_name}'].get
$.paths['/user/packages/{package_type}/{package_name}'].delete
$.paths['/user/packages/{package_type}/{package_name}/restore'].post
$.paths['/user/packages/{package_type}/{package_name}/versions'].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 v3 REST Packages API
  version: 1.0.0
extends: openapi/github-packages-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 27
- target: $.paths['/orgs/{org}/docker/conflicts'].get
  update:
    x-apievangelist-phrasing:
      intent: List an org's packages that conflicted in Docker migration
      effect: read
      questions:
      - Which of our organization's packages ran into a conflict when migrating from the Docker registry?
      - Did any org container images fail to move over cleanly during the Docker migration?
      instructions:
      - text: List the packages in {org} that hit a conflict during the Docker migration.
        slots:
          org: path.org
      - text: Show Docker migration conflicts for organization {org}.
        slots:
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/packages'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's packages
      effect: read
      questions:
      - What npm, Maven or container packages does our organization publish?
      - Can I list only the private packages in an org?
      instructions:
      - text: List the {package_type} packages in organization {org}.
        slots:
          package_type: query.package_type
          org: path.org
      - text: Show {visibility} {package_type} packages owned by {org}.
        slots:
          visibility: query.visibility
          package_type: query.package_type
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/packages/{package_type}/{package_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one package owned by an organization
      effect: read
      questions:
      - What are the details of a specific package our organization publishes, like visibility and version count?
      - Can I look up one org-owned container image by name?
      instructions:
      - text: Show the {package_type} package {package_name} in organization {org}.
        slots:
          package_type: path.package_type
          package_name: path.package_name
          org: path.org
      - text: Get details for org package {package_name} ({package_type}) owned by {org}.
        slots:
          package_type: path.package_type
          package_name: path.package_name
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/packages/{package_type}/{package_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an entire organization package
      effect: destructive
      questions:
      - How do I delete a whole package, every version, from our organization?
      - Can a package with more than 5,000 downloads be removed from the org?
      instructions:
      - text: Delete the entire {package_type} package {package_name} from organization {org}.
        slots:
          package_type: path.package_type
          package_name: path.package_name
          org: path.org
      - text: Remove org package {package_name} of type {package_type} from {org} completely.
        slots:
          package_type: path.package_type
          package_name: path.package_name
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/packages/{package_type}/{package_name}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a deleted organization package
      effect: write
      questions:
      - Can I bring back a package our organization deleted a couple of weeks ago?
      - How long after deleting an org package can it still be restored?
      instructions:
      - text: Restore the deleted {package_type} package {package_name} in organization {org}.
        slots:
          package_type: path.package_type
          package_name: path.package_name
          org: path.org
      - text: Undelete org package {package_name} ({package_type}) in {org} using token {token}.
        slots:
          package_type: path.package_type
          package_name: path.package_name
          org: path.org
          token: query.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/packages/{package_type}/{package_name}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List versions of an organization package
      effect: read
      questions:
      - Which versions of an organization's package have been published?
      - Can I see only the deleted versions of an org package?
      instructions:
      - text: List all versions of {package_type} package {package_name} in organization {org}.
        slots:
          package_type: path.package_type
          package_name: path.package_name
          org: path.org
      - text: Show {state} versions of org package {package_name} ({package_type}) in {org}.
        slots:
          package_type: path.package_type
          package_name: path.package_name
          org: path.org
          state: query.state
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one version of an organization package
      effect: read
      questions:
      - What are the details of one specific version of an org package, like its tags and creation date?
      - Can I inspect a single version of an organization's container image?
      instructions:
      - text: Show version {package_version_id} of {package_type} package {package_name} in organization {org}.
        slots:
          package_version_id: path.package_version_id
          package_type: path.package_type
          package_name: path.package_name
          org: path.org
      - text: Get details of org package {package_name} ({package_type}) version {package_version_id} in {org}.
        slots:
          package_version_id: path.package_version_id
          package_type: path.package_type
          package_name: path.package_name
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one version of an organization package
      effect: destructive
      questions:
      - Can I delete just one bad version of an org package and keep the rest?
      - How do I remove a single published version from an organization's package?
      instructions:
      - text: Delete version {package_version_id} of {package_type} package {package_name} in organization {org}.
        slots:
          package_version_id: path.package_version_id
          package_type: path.package_type
          package_name: path.package_name
          org: path.org
      - text: Remove only version {package_version_id} from org package {package_name} ({package_type}) in {org}.
        slots:
          package_version_id: path.package_version_id
          package_type: path.package_type
          package_name: path.package_name
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a deleted organization package version
      effect: write
      questions:
      - Is it possible to recover a single version I deleted from an organization's package?
      - Can I undo the deletion of one org package version within 30 days?
      instructions:
      - text: Restore deleted version {package_version_id} of {package_type} package {package_name} in organization {org}.
        slots:
          package_version_id: path.package_version_id
          package_type: path.package_type
          package_name: path.package_name
          org: path.org
      - text: Undelete org package {package_name} ({package_type}) version {package_version_id} in {org}.
        slots:
          package_version_id: path.package_version_id
          package_type: path.package_type
          package_name: path.package_name
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/user/docker/conflicts'].get
  update:
    x-apievangelist-phrasing:
      intent: List my packages that conflicted in Docker migration
      effect: read
      questions:
      - Did any of my own packages hit a conflict during the Docker registry migration?
      - Which of my personal container images failed to migrate cleanly?
      instructions:
      - text: List my own packages that had a conflict during the Docker migration.
      - text: Show Docker migration conflicts in my personal namespace.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/user/packages'].get
  update:
    x-apievangelist-phrasing:
      intent: List packages in my own namespace
      effect: read
      questions:
      - What packages have I published under my own account?
      - Can I list just my public container images?
      instructions:
      - text: List my {package_type} packages.
        slots:
          package_type: query.package_type
      - text: Show my own {visibility} {package_type} packages.
        slots:
          visibility: query.visibility
          package_type: query.package_type
      method: generated
      generated: '2026-09-24'
- target: $.paths['/user/packages/{package_type}/{package_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one of my own packages
      effect: read
      questions:
      - What are the details of one package I own personally?
      - Can I look up my own npm package by name and type?
      instructions:
      - text: Show my {package_type} package {package_name}.
        slots:
          package_type: path.package_type
          package_name: path.package_name
      - text: Get details of package {package_name} ({package_type}) in my own namespace.
        slots:
          package_type: path.package_type
          package_name: path.package_name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/user/packages/{package_type}/{package_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one of my own packages
      effect: destructive
      questions:
      - How do I delete a package I published under my personal account?
      - Can I remove every version of my own package at once?
      instructions:
      - text: Delete my {package_type} package {package_name}.
        slots:
          package_type: path.package_type
          package_name: path.package_name
      - text: Remove my personal package {package_name} ({package_type}) entirely.
        slots:
          package_type: path.package_type
          package_name: path.package_name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/user/packages/{package_type}/{package_name}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore one of my deleted packages
      effect: write
      questions:
      - Can I get back a package I deleted from my own account last week?
      - What stops me from restoring a deleted personal package?
      instructions:
      - text: Restore my deleted {package_type} package {package_name}.
        slots:
          package_type: path.package_type
          package_name: path.package_name
      - text: Undelete my personal package {package_name} ({package_type}) with token {token}.
        slots:
          package_type: path.package_type
          package_name: path.package_name
          token: query.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/user/packages/{package_type}/{package_name}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List versions of one of my packages
      effect: read
      questions:
      - Which versions of my own package exist right now?
      - Can I see the deleted versions of a package in my account?
      instructions:
      - text: List all versions of my {package_type} package {package_name}.
        slots:
          package_type: path.package_type
          package_name: path.package_name
      - text: Show {state} versions of my package {package_name} ({package_type}).
        slots:
          package_type: path.package_type
          package_name: path.package_name
          state: query.state
      method: generated
      generated: '2026-09-24'
- target: $.paths['/user/packages/{package_type}/{package_name}/versions/{package_version_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one version of one of my packages
      effect: read
      questions:
      - What's recorded about a single version of a package I own?
      - Can I check the metadata for one release of my personal package?
      instructions:
      - text: Show version {package_version_id} of my {package_type} package {package_name}.
        slots:
          package_version_id: path.package_version_id
          package_type: path.package_type
          package_name: path.package_name
      - text: Get my package {package_name} ({package_type}) release {package_version_id}.
        slots:
          package_version_id: path.package_version_id
          package_type: path.package_type
          package_name: path.package_name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/user/packages/{package_type}/{package_name}/versions/{package_version_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one version of one of my packages
      effect: destructive
      questions:
      - Can I delete a single broken release of my own package?
      - How do I remove one version from a package in my personal namespace?
      instructions:
      - text: Delete version {package_version_id} of my {package_type} package {package_name}.
        slots:
          package_version_id: path.package_version_id
          package_type: path.package_type
          package_name: path.package_name
      - text: Remove only release {package_version_id} from my package {package_name} ({package_type}).
        slots:
          package_version_id: path.package_version_id
          package_type: path.package_type
          package_name: path.package_name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a deleted version of one of my packages
      effect: write
      questions:
      - Is it possible to bring back one version I deleted from my own package?
      - Can I recover a personal package release I removed by mistake?
      instructions:
      - text: Restore deleted version {package_version_id} of my {package_type} package {package_name}.
        slots:
          package_version_id: path.package_version_id
          package_type: path.package_type
          package_name: path.package_name
      - text: Undelete release {package_version_id} of my package {package_name} ({package_type}).
        slots:
          package_version_id: path.package_version_id
          package_type: path.package_type
          package_name: path.package_name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/users/{username}/docker/conflicts'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's packages that conflicted in Docker migration
      effect: read
      questions:
      - Which of another user's packages ran into Docker migration conflicts?
      - Can I check whether a specific user's container images migrated cleanly?
      instructions:
      - text: List the packages owned by {username} that conflicted during the Docker migration.
        slots:
          username: path.username
      - text: Show Docker migration conflicts for user {username}.
        slots:
          username: path.username
      method: generated
      generated: '2026-09-24'
- target: $.paths['/users/{username}/packages'].get
  update:
    x-apievangelist-phrasing:
      intent: List another user's packages
      effect: read
      questions:
      - What packages has a given user published?
      - Can I list only the public container packages of a specific user?
      instructions:
      - text: List the {package_type} packages owned by user {username}.
        slots:
          package_type: query.package_type
          username: path.username
      - text: Show {visibility} {package_type} packages belonging to {username}.
        slots:
          visibility: query.visibility
          package_type: query.package_type
          username: path.username
      method: generated
      generated: '2026-09-24'
- target: $.paths['/users/{username}/packages/{package_type}/{package_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one package owned by another user
      effect: read
      questions:
      - What are the details of a package another user publishes?
      - Can I look up a specific user's Maven package by name?
      instructions:
      - text: Show {package_type} package {package_name} owned by user {username}.
        slots:
          package_type: path.package_type
          package_name: path.package_name
          username: path.username
      - text: Get details of {username}'s package {package_name} ({package_type}).
        slots:
          package_type: path.package_type
          package_name: path.package_name
          username: path.username
      method: generated
      generated: '2026-09-24'
- target: $.paths['/users/{username}/packages/{package_type}/{package_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an entire package owned by a user
      effect: destructive
      questions:
      - Can an admin delete an entire package owned by a specific user account?
      - How do I remove every version of a package that belongs to another user?
      instructions:
      - text: Delete the entire {package_type} package {package_name} owned by user {username}.
        slots:
          package_type: path.package_type
          package_name: path.package_name
          username: path.username
      - text: Remove {username}'s package {package_name} ({package_type}) completely.
        slots:
          package_type: path.package_type
          package_name: path.package_name
          username: path.username
      method: generated
      generated: '2026-09-24'
- target: $.paths['/users/{username}/packages/{package_type}/{package_name}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a deleted package owned by a user
      effect: write
      questions:
      - Can I restore a whole package that was deleted from another user's account?
      - Is there a way to recover a user-owned package after it was removed?
      instructions:
      - text: Restore the deleted {package_type} package {package_name} owned by user {username}.
        slots:
          package_type: path.package_type
          package_name: path.package_name
          username: path.username
      - text: Undelete {username}'s package {package_name} ({package_type}) using token {token}.
        slots:
          package_type: path.package_type
          package_name: path.package_name
          username: path.username
          token: query.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/users/{username}/packages/{package_type}/{package_name}/versions'].get
  update:
    x-apievangelist-phrasing:
      intent: List versions of a package owned by a user
      effect: read
      questions:
      - Which versions has another user published for one of their packages?
      - Can I see the release history of a specific user's package?
      instructions:
      - text: List all versions of {package_type} package {package_name} owned by user {username}.
        slots:
          package_type: path.package_type
          package_name: path.package_name
          username: path.username
      - text: Show the release history of {username}'s package {package_name} ({package_type}).
        slots:
          package_type: path.package_type
          package_name: path.package_name
          username: path.username
      method: generated
      generated: '2026-09-24'
- target: $.paths['/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one version of a package owned by a user
      effect: read
      questions:
      - What are the details of one release of another user's package?
      - Can I inspect a single version of a package that belongs to someone else?
      instructions:
      - text: Show version {package_version_id} of {package_type} package {package_name} owned by user {username}.
        slots:
          package_version_id: path.package_version_id
          package_type: path.package_type
          package_name: path.package_name
          username: path.username
      - text: Get {username}'s package {package_name} ({package_type}) release {package_version_id}.
        slots:
          package_version_id: path.package_version_id
          package_type: path.package_type
          package_name: path.package_name
          username: path.username
      method: generated
      generated: '2026-09-24'
- target: $.paths['/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one version of a package owned by a user
      effect: destructive
      questions:
      - Can I delete a single version of a package that another user owns?
      - How does an admin remove one bad release from a user's package?
      instructions:
      - text: Delete version {package_version_id} of {package_type} package {package_name} owned by user {username}.
        slots:
          package_version_id: path.package_version_id
          package_type: path.package_type
          package_name: path.package_name
          username: path.username
      - text: Remove only release {package_version_id} from {username}'s package {package_name} ({package_type}).
        slots:
          package_version_id: path.package_version_id
          package_type: path.package_type
          package_name: path.package_name
          username: path.username
      method: generated
      generated: '2026-09-24'
- target: $.paths['/users/{username}/packages/{package_type}/{package_name}/versions/{package_version_id}/restore'].post
  update:
    x-apievangelist-phrasing:
      intent: Restore a deleted version of a user's package
      effect: write
      questions:
      - Is it possible to recover one deleted version of another user's package?
      - Can I restore a single release removed from a user-owned package within the 30-day window?
      instructions:
      - text: Restore deleted version {package_version_id} of {package_type} package {package_name} owned by user {username}.
        slots:
          package_version_id: path.package_version_id
          package_type: path.package_type
          package_name: path.package_name
          username: path.username
      - text: Undelete release {package_version_id} of {username}'s package {package_name} ({package_type}).
        slots:
          package_version_id: path.package_version_id
          package_type: path.package_type
          package_name: path.package_name
          username: path.username
      method: generated
      generated: '2026-09-24'