Ghost · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ghost Admin Offers API

5 actions 5 updates phrasing extends openapi/ghost-org-offers-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Ghost's API. It is a proposal applied on top of the contract, not a document Ghost publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/offers/'].get
$.paths['/offers/'].post
$.paths['/offers/{id}/'].get
$.paths['/offers/{id}/'].put

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 Ghost Admin Offers API
  version: 1.0.0
extends: openapi/ghost-org-offers-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: 4
- target: $.paths['/offers/'].get
  update:
    x-apievangelist-phrasing:
      intent: List offers
      effect: read
      questions:
      - What promotional offers are running on my publication?
      - Can I filter offers to see only active ones?
      instructions:
      - text: List offers matching {filter}.
        slots:
          filter: query.filter
      - text: Show me page {page} of offers, {limit} at a time.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/offers/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a promotional offer
      effect: write
      questions:
      - How do I create a percentage discount for a paid tier?
      - Can I offer a free trial period on a membership tier?
      instructions:
      - text: Create offer {offers}.
        slots:
          offers: requestBody.offers
      - text: Set up a discount offer on a paid tier using {offers}.
        slots:
          offers: requestBody.offers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/offers/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an offer by ID
      effect: read
      questions:
      - How do I look up the details of one offer?
      - Can I check an offer's discount amount by its ID?
      instructions:
      - text: Get offer {id}.
        slots:
          id: path.id
      - text: Show offer {id} with only {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/offers/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an offer
      effect: write
      questions:
      - How do I change an offer that's already created?
      - Can I rename an offer or update its display text?
      instructions:
      - text: Update offer {id} with {offers}.
        slots:
          id: path.id
          offers: requestBody.offers
      - text: Rename offer {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'