GitHub · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitHub v3 REST Dependency Graph API

4 actions 4 updates phrasing extends openapi/github-dependency-graph-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 4

$.info
$.paths['/repos/{owner}/{repo}/dependency-graph/compare/{basehead}'].get
$.paths['/repos/{owner}/{repo}/dependency-graph/sbom'].get
$.paths['/repos/{owner}/{repo}/dependency-graph/snapshots'].post

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 Dependency Graph API
  version: 1.0.0
extends: openapi/github-dependency-graph-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: 3
- target: $.paths['/repos/{owner}/{repo}/dependency-graph/compare/{basehead}'].get
  update:
    x-apievangelist-phrasing:
      intent: Compare dependency changes between two commits
      effect: read
      questions:
      - Which dependencies were added or removed between two commits in my repo?
      - Can I see the dependency changes for just one manifest file between two revisions?
      - What changed in my package dependencies between main and my feature branch?
      instructions:
      - text: Show the dependency diff for {owner}/{repo} across {basehead}.
        slots:
          owner: path.owner
          repo: path.repo
          basehead: path.basehead
      - text: Compare dependencies in {owner}/{repo} for {basehead}, limited to the manifest at {name}.
        slots:
          owner: path.owner
          repo: path.repo
          basehead: path.basehead
          name: query.name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/dependency-graph/sbom'].get
  update:
    x-apievangelist-phrasing:
      intent: Export a repository's SBOM
      effect: read
      questions:
      - How do I get a software bill of materials for my GitHub repository?
      - Can I export my repo's SBOM in SPDX JSON format?
      instructions:
      - text: Export the SPDX software bill of materials for {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Generate an SBOM for the {repo} repository owned by {owner}.
        slots:
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/dependency-graph/snapshots'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a dependency snapshot for a repository
      effect: write
      questions:
      - How do I submit dependencies my build detected to the dependency graph?
      - Can I upload a snapshot of resolved dependencies for a specific commit and branch?
      instructions:
      - text: Submit a dependency snapshot to {owner}/{repo} for commit {sha} on {ref}, scanned at {scanned}.
        slots:
          owner: path.owner
          repo: path.repo
          sha: requestBody.sha
          ref: requestBody.ref
          scanned: requestBody.scanned
      - text: Upload the dependency manifests {manifests} to the dependency graph of {owner}/{repo}.
        slots:
          manifests: requestBody.manifests
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'