Ghost · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ghost Content and Admin Admin - Offers API

4 actions 4 updates phrasing extends openapi/ghost-org-admin-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 4

$.info
$.paths['/admin/offers/'].get
$.paths['/admin/offers/'].post
$.paths['/admin/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 Content and Admin Admin - Offers API
  version: 1.0.0
extends: openapi/ghost-org-admin-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: 3
- target: $.paths['/admin/offers/'].get
  update:
    x-apievangelist-phrasing:
      intent: List offers
      effect: read
      questions:
      - Which promotional offers do I currently have?
      - How do I see all discount offers on my site?
      instructions:
      - text: List all my offers.
      - text: Show me every promotional offer I've created.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/offers/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a promotional offer
      effect: write
      questions:
      - How do I create a discount offer for new paid members?
      - Can I set up a promo for a paid tier?
      instructions:
      - text: Create a new discount offer for my paid tier.
      - text: Set up a promotional offer for Black Friday.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/offers/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an offer
      effect: write
      questions:
      - Can I change the name or code of an offer that's already live?
      - How do I edit an existing promotional offer?
      instructions:
      - text: Update offer {id}.
        slots:
          id: path.id
      - text: Rename offer {id} to Spring Sale.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'