GitHub · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitHub v3 REST Dependabot API

20 actions 20 updates phrasing extends openapi/github-dependabot-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 20 · first 16 shown; the file carries all of them

$.info
$.paths['/enterprises/{enterprise}/dependabot/alerts'].get
$.paths['/orgs/{org}/dependabot/alerts'].get
$.paths['/orgs/{org}/dependabot/secrets'].get
$.paths['/orgs/{org}/dependabot/secrets/public-key'].get
$.paths['/orgs/{org}/dependabot/secrets/{secret_name}'].get
$.paths['/orgs/{org}/dependabot/secrets/{secret_name}'].put
$.paths['/orgs/{org}/dependabot/secrets/{secret_name}'].delete
$.paths['/orgs/{org}/dependabot/secrets/{secret_name}/repositories'].get
$.paths['/orgs/{org}/dependabot/secrets/{secret_name}/repositories'].put
$.paths['/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}'].put
$.paths['/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}'].delete
$.paths['/repos/{owner}/{repo}/dependabot/alerts'].get
$.paths['/repos/{owner}/{repo}/dependabot/alerts/{alert_number}'].get
$.paths['/repos/{owner}/{repo}/dependabot/alerts/{alert_number}'].patch
$.paths['/repos/{owner}/{repo}/dependabot/secrets'].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 Dependabot API
  version: 1.0.0
extends: openapi/github-dependabot-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: 19
- target: $.paths['/enterprises/{enterprise}/dependabot/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List Dependabot alerts across an enterprise
      effect: read
      questions:
      - Which vulnerable dependencies are open across every repo in our enterprise?
      - Can I see only critical Dependabot alerts enterprise-wide?
      - Is it possible to filter enterprise alerts to just the npm ecosystem?
      instructions:
      - text: List open Dependabot alerts for enterprise {enterprise}.
        slots:
          enterprise: path.enterprise
      - text: Show {severity} severity Dependabot alerts across enterprise {enterprise} in the {ecosystem} ecosystem.
        slots:
          severity: query.severity
          enterprise: path.enterprise
          ecosystem: query.ecosystem
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/dependabot/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List Dependabot alerts for an organization
      effect: read
      questions:
      - What Dependabot security alerts are open across my organization's repos?
      - Can I find every org alert affecting one specific package?
      - Who is allowed to list Dependabot alerts for a whole org?
      instructions:
      - text: List Dependabot alerts across the {org} organization.
        slots:
          org: path.org
      - text: Show {state} org-level Dependabot alerts in {org} for package {package}.
        slots:
          state: query.state
          org: path.org
          package: query.package
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/dependabot/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's Dependabot secrets
      effect: read
      questions:
      - What Dependabot secrets has my organization defined?
      - Can I see org Dependabot secret names without exposing their values?
      instructions:
      - text: List the Dependabot secrets in organization {org}.
        slots:
          org: path.org
      - text: Show all org-level Dependabot secret names for {org}.
        slots:
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/dependabot/secrets/public-key'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the org key for encrypting Dependabot secrets
      effect: read
      questions:
      - Which public key do I encrypt an organization Dependabot secret with?
      - Where do I get the key_id to send with a new org secret?
      instructions:
      - text: Get the Dependabot secrets public key for organization {org}.
        slots:
          org: path.org
      - text: Fetch the encryption key and key ID for {org}'s Dependabot secrets.
        slots:
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/dependabot/secrets/{secret_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one organization Dependabot secret
      effect: read
      questions:
      - When was an org Dependabot secret last updated and who can use it?
      - Can I check the visibility of a single organization Dependabot secret?
      instructions:
      - text: Get the org Dependabot secret {secret_name} in {org}.
        slots:
          secret_name: path.secret_name
          org: path.org
      - text: Show visibility and update time for organization secret {secret_name} in {org}.
        slots:
          secret_name: path.secret_name
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/dependabot/secrets/{secret_name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update an org Dependabot secret
      effect: write
      questions:
      - How do I add a private registry token as a Dependabot secret for my whole org?
      - Can I make an org Dependabot secret available to only selected repositories?
      - Does the secret value need to be encrypted before I send it?
      instructions:
      - text: Save org Dependabot secret {secret_name} in {org} with encrypted value {encrypted_value}, key {key_id}, visibility {visibility}.
        slots:
          secret_name: path.secret_name
          org: path.org
          encrypted_value: requestBody.encrypted_value
          key_id: requestBody.key_id
          visibility: requestBody.visibility
      - text: Set organization secret {secret_name} in {org} to {visibility} visibility for repos {selected_repository_ids}.
        slots:
          secret_name: path.secret_name
          org: path.org
          visibility: requestBody.visibility
          selected_repository_ids: requestBody.selected_repository_ids
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/dependabot/secrets/{secret_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization Dependabot secret
      effect: destructive
      questions:
      - How can I remove an organization-level Dependabot secret?
      - What scope does my token need to delete an org Dependabot secret?
      instructions:
      - text: Delete org Dependabot secret {secret_name} from {org}.
        slots:
          secret_name: path.secret_name
          org: path.org
      - text: Remove the organization secret {secret_name} used by Dependabot in {org}.
        slots:
          secret_name: path.secret_name
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/dependabot/secrets/{secret_name}/repositories'].get
  update:
    x-apievangelist-phrasing:
      intent: List repos allowed to use an org Dependabot secret
      effect: read
      questions:
      - Which repositories can use an org Dependabot secret set to selected visibility?
      - Can I see the allow-list of repos for a Dependabot secret?
      instructions:
      - text: List repositories selected for org secret {secret_name} in {org}.
        slots:
          secret_name: path.secret_name
          org: path.org
      - text: Show which repos may read Dependabot secret {secret_name} in the {org} organization.
        slots:
          secret_name: path.secret_name
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/dependabot/secrets/{secret_name}/repositories'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace the repo list for an org Dependabot secret
      effect: write
      questions:
      - Can I overwrite the full set of repositories allowed to use an org Dependabot secret?
      - Does setting selected repositories replace the existing list?
      instructions:
      - text: Replace the repositories for org secret {secret_name} in {org} with {selected_repository_ids}.
        slots:
          secret_name: path.secret_name
          org: path.org
          selected_repository_ids: requestBody.selected_repository_ids
      - text: Set exactly repos {selected_repository_ids} as the allow-list for Dependabot secret {secret_name} in {org}.
        slots:
          selected_repository_ids: requestBody.selected_repository_ids
          secret_name: path.secret_name
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a repo to an org Dependabot secret
      effect: write
      questions:
      - How do I let one more repository use an org Dependabot secret?
      - Does adding a single repo to a secret work when visibility isn't selected?
      instructions:
      - text: Add repository {repository_id} to org secret {secret_name} in {org}.
        slots:
          repository_id: path.repository_id
          secret_name: path.secret_name
          org: path.org
      - text: Allow repo ID {repository_id} to use Dependabot secret {secret_name} in the {org} organization.
        slots:
          repository_id: path.repository_id
          secret_name: path.secret_name
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/orgs/{org}/dependabot/secrets/{secret_name}/repositories/{repository_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a repo from an org Dependabot secret
      effect: destructive
      questions:
      - Can I stop one repository from using an org Dependabot secret?
      - How do I take a repo off a Dependabot secret's allow-list?
      instructions:
      - text: Remove repository {repository_id} from org secret {secret_name} in {org}.
        slots:
          repository_id: path.repository_id
          secret_name: path.secret_name
          org: path.org
      - text: Revoke repo ID {repository_id}'s access to Dependabot secret {secret_name} in the {org} organization.
        slots:
          repository_id: path.repository_id
          secret_name: path.secret_name
          org: path.org
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/dependabot/alerts'].get
  update:
    x-apievangelist-phrasing:
      intent: List Dependabot alerts for a repository
      effect: read
      questions:
      - Which vulnerable dependencies has Dependabot flagged in my repository?
      - Can I see only high and critical alerts for one manifest file?
      - How do I list alerts I've already dismissed in a repo?
      instructions:
      - text: List Dependabot alerts for {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Show {severity} alerts in {owner}/{repo} for manifest {manifest}.
        slots:
          severity: query.severity
          owner: path.owner
          repo: path.repo
          manifest: query.manifest
      - text: List {state} Dependabot alerts in repo {owner}/{repo}, sorted by {sort}.
        slots:
          state: query.state
          owner: path.owner
          repo: path.repo
          sort: query.sort
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/dependabot/alerts/{alert_number}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one Dependabot alert
      effect: read
      questions:
      - What vulnerability and package does a specific Dependabot alert refer to?
      - Can I pull the details of a single alert by its number?
      instructions:
      - text: 'Get Dependabot alert #{alert_number} in {owner}/{repo}.'
        slots:
          alert_number: path.alert_number
          owner: path.owner
          repo: path.repo
      - text: Show the vulnerable package and advisory for alert {alert_number} of {owner}/{repo}.
        slots:
          alert_number: path.alert_number
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/dependabot/alerts/{alert_number}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Dismiss or reopen a Dependabot alert
      effect: write
      questions:
      - How do I dismiss a Dependabot alert as a false positive?
      - Is a reason required when I dismiss an alert?
      - Can I reopen an alert I dismissed by mistake?
      instructions:
      - text: 'Dismiss alert #{alert_number} in {owner}/{repo} with reason {dismissed_reason}.'
        slots:
          alert_number: path.alert_number
          owner: path.owner
          repo: path.repo
          dismissed_reason: requestBody.dismissed_reason
      - text: Set Dependabot alert {alert_number} in {owner}/{repo} to state {state}.
        slots:
          alert_number: path.alert_number
          owner: path.owner
          repo: path.repo
          state: requestBody.state
      - text: Dismiss alert {alert_number} on {owner}/{repo} as {dismissed_reason} with the note {dismissed_comment}.
        slots:
          alert_number: path.alert_number
          owner: path.owner
          repo: path.repo
          dismissed_reason: requestBody.dismissed_reason
          dismissed_comment: requestBody.dismissed_comment
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/dependabot/secrets'].get
  update:
    x-apievangelist-phrasing:
      intent: List a repository's Dependabot secrets
      effect: read
      questions:
      - What Dependabot secrets are configured on this repository?
      - Can I list repo-level Dependabot secrets without seeing their values?
      instructions:
      - text: List the Dependabot secrets in repository {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Show all repo-level Dependabot secret names for {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/dependabot/secrets/public-key'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the repo key for encrypting Dependabot secrets
      effect: read
      questions:
      - Which public key should I use to encrypt a repository Dependabot secret?
      - Can someone with only read access get a repo's Dependabot public key?
      instructions:
      - text: Get the Dependabot secrets public key for repository {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Fetch the repository-level encryption key and key ID used for Dependabot secrets on {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/dependabot/secrets/{secret_name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one repository Dependabot secret
      effect: read
      questions:
      - When was a repository's Dependabot secret created or last changed?
      - Does a given repo Dependabot secret exist?
      instructions:
      - text: Get the repo Dependabot secret {secret_name} in {owner}/{repo}.
        slots:
          secret_name: path.secret_name
          owner: path.owner
          repo: path.repo
      - text: Show metadata for repository secret {secret_name} on {owner}/{repo}.
        slots:
          secret_name: path.secret_name
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/dependabot/secrets/{secret_name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Create or update a repo Dependabot secret
      effect: write
      questions:
      - How do I give Dependabot a registry credential for just one repository?
      - What encryption does a repository Dependabot secret need before upload?
      instructions:
      - text: Save repo Dependabot secret {secret_name} in {owner}/{repo} with encrypted value {encrypted_value} and key {key_id}.
        slots:
          secret_name: path.secret_name
          owner: path.owner
          repo: path.repo
          encrypted_value: requestBody.encrypted_value
          key_id: requestBody.key_id
      - text: Update repository secret {secret_name} on {owner}/{repo} to new encrypted value {encrypted_value}.
        slots:
          secret_name: path.secret_name
          owner: path.owner
          repo: path.repo
          encrypted_value: requestBody.encrypted_value
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/dependabot/secrets/{secret_name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a repository Dependabot secret
      effect: destructive
      questions:
      - How can I remove a Dependabot secret from a single repository?
      - What token scope is needed to delete a repo Dependabot secret?
      instructions:
      - text: Delete repo Dependabot secret {secret_name} from {owner}/{repo}.
        slots:
          secret_name: path.secret_name
          owner: path.owner
          repo: path.repo
      - text: Remove the repository secret {secret_name} used by Dependabot on {owner}/{repo}.
        slots:
          secret_name: path.secret_name
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'