GitHub · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitHub v3 REST Codes Of Conduct API

3 actions 3 updates phrasing extends openapi/github-codes-of-conduct-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 3

$.info

$.paths['/codes_of_conduct'].get

$.paths['/codes_of_conduct/{key}'].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 Codes Of Conduct API
  version: 1.0.0
extends: openapi/github-codes-of-conduct-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: 2
- target: $.paths['/codes_of_conduct'].get
  update:
    x-apievangelist-phrasing:
      intent: List all available codes of conduct
      effect: read
      questions:
      - Which codes of conduct does GitHub offer for projects?
      - What code of conduct templates can I choose from for my open source repo?
      instructions:
      - text: List every code of conduct GitHub provides.
      - text: Show me all the code of conduct templates I can pick from.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/codes_of_conduct/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single code of conduct by key
      effect: read
      questions:
      - What does the full text of the Contributor Covenant code of conduct say?
      - Can I read the details of one specific code of conduct by its key?
      instructions:
      - text: Get the code of conduct with key {key}.
        slots:
          key: path.key
      - text: Show me the full text of the {key} code of conduct.
        slots:
          key: path.key
      method: generated
      generated: '2026-09-24'