Netlify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Netlify's API documentation Ticket API

3 actions 3 updates phrasing extends openapi/netlify-ticket-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Netlify's API. It is a proposal applied on top of the contract, not a document Netlify publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/oauth/tickets'].post

$.paths['/oauth/tickets/{ticket_id}'].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 Netlify's API documentation Ticket API
  version: 1.0.0
extends: openapi/netlify-ticket-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/oauth/tickets'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an OAuth authorization ticket
      effect: write
      questions:
      - How does my app start an OAuth ticket flow for a user?
      - Can I include a message when creating an authorization ticket?
      instructions:
      - text: Create an OAuth ticket for client {client}.
        slots:
          client: query.client_id
      - text: Start an authorization ticket for client {client} with message {message}.
        slots:
          client: query.client_id
          message: requestBody.message
      method: generated
      generated: '2026-09-26'
- target: $.paths['/oauth/tickets/{ticket_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check an OAuth ticket's status
      effect: read
      questions:
      - Has the user authorized my OAuth ticket yet?
      - Can I poll a ticket to see if it's been approved?
      instructions:
      - text: Get OAuth ticket {ticket}.
        slots:
          ticket: path.ticket_id
      - text: Check whether ticket {ticket} has been authorized.
        slots:
          ticket: path.ticket_id
      method: generated
      generated: '2026-09-26'