GitHub · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitHub v3 REST Licenses API

4 actions 4 updates phrasing extends openapi/github-licenses-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['/licenses'].get

$.paths['/licenses/{license}'].get

$.paths['/repos/{owner}/{repo}/license'].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 v3 REST Licenses API
  version: 1.0.0
extends: openapi/github-licenses-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['/licenses'].get
  update:
    x-apievangelist-phrasing:
      intent: List commonly used open source licenses
      effect: read
      questions:
      - Which open source licenses are most commonly used on GitHub?
      - Can I list only the featured licenses to offer in a picker?
      instructions:
      - text: List the commonly used licenses.
      - text: Show only the featured licenses, featured set to {featured}.
        slots:
          featured: query.featured
      method: generated
      generated: '2026-09-24'
- target: $.paths['/licenses/{license}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the details of one license
      effect: read
      questions:
      - What permissions, conditions and limitations does a specific license like MIT carry?
      - Can I get the full text of one license by its key?
      instructions:
      - text: Get the {license} license.
        slots:
          license: path.license
      - text: Show the full text and permissions of license {license}.
        slots:
          license: path.license
      method: generated
      generated: '2026-09-24'
- target: $.paths['/repos/{owner}/{repo}/license'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a repository's license
      effect: read
      questions:
      - Which license does a particular repository use?
      - Can I read the contents of a repo's detected license file?
      instructions:
      - text: Get the license for {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      - text: Show the license file contents detected in repository {owner}/{repo}.
        slots:
          owner: path.owner
          repo: path.repo
      method: generated
      generated: '2026-09-24'