GitHub · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitHub v3 REST Meta API

5 actions 5 updates phrasing extends openapi/github-meta-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 5

$.info
$.paths['/'].get
$.paths['/meta'].get
$.paths['/octocat'].get
$.paths['/zen'].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 Meta API
  version: 1.0.0
extends: openapi/github-meta-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: 4
- target: $.paths['/'].get
  update:
    x-apievangelist-phrasing:
      intent: Discover the API's top-level resource links
      effect: read
      questions:
      - What resource URLs does the REST API root advertise?
      - Can I discover the main endpoint templates from a single starting URL?
      instructions:
      - text: Fetch the API root and list the hypermedia links it returns.
      - text: Show me the endpoint URL templates advertised at the REST API root.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/meta'].get
  update:
    x-apievangelist-phrasing:
      intent: Get server meta information
      effect: read
      questions:
      - What meta information does my GitHub Enterprise Server instance publish about itself?
      - Where can I find the server's installed version and other instance metadata?
      instructions:
      - text: Get the meta information for this Enterprise Server instance.
      - text: Show the instance metadata the server publishes at its meta endpoint.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/octocat'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Octocat as ASCII art
      effect: read
      questions:
      - Can I get the Octocat drawn as ASCII art with my own message in a speech bubble?
      - What's a fun endpoint I can hit to test that my client works?
      instructions:
      - text: Draw the Octocat in ASCII art.
      - text: Show the ASCII Octocat saying {s}.
        slots:
          s: query.s
      method: generated
      generated: '2026-09-24'
- target: $.paths['/zen'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a random Zen of GitHub saying
      effect: read
      questions:
      - What's a random line from the Zen of GitHub?
      - Is there an endpoint that returns a short design-philosophy quote?
      instructions:
      - text: Give me a random Zen of GitHub sentence.
      - text: Fetch today's zen quote from the API.
      method: generated
      generated: '2026-09-24'