# 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 Markdown API
  version: 1.0.0
extends: openapi/github-markdown-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['/markdown'].post
  update:
    x-apievangelist-phrasing:
      intent: Render Markdown to HTML
      effect: read
      questions:
      - How do I turn Markdown into HTML the same way GitHub displays it?
      - 'Can issue references like #42 link to the right repository when I render GitHub Flavored Markdown?'
      instructions:
      - text: Render {text} as HTML.
        slots:
          text: requestBody.text
      - text: Render {text} in {mode} mode with repository context {context}.
        slots:
          text: requestBody.text
          mode: requestBody.mode
          context: requestBody.context
      method: generated
      generated: '2026-09-24'
- target: $.paths['/markdown/raw'].post
  update:
    x-apievangelist-phrasing:
      intent: Render plain-text Markdown like a README
      effect: read
      questions:
      - Can I send Markdown as plain text instead of JSON and get HTML back?
      - What's the size limit for rendering a raw Markdown document without GitHub Flavored extensions?
      instructions:
      - text: Render this plain-text Markdown file in raw mode, the way a README displays.
      - text: Post my Markdown as text/plain and return raw-mode HTML.
      method: generated
      generated: '2026-09-24'