Ghost · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ghost Org Tiers API

5 actions 5 updates phrasing extends openapi/ghost-org-tiers-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['/tiers/'].get
$.paths['/tiers/'].post
$.paths['/tiers/{id}/'].get
$.paths['/tiers/{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 Org Tiers API
  version: 1.0.0
extends: openapi/ghost-org-tiers-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['/tiers/'].get
  update:
    x-apievangelist-phrasing:
      intent: List membership tiers
      effect: read
      questions:
      - What membership tiers do I offer?
      - Can I filter tiers to only paid ones?
      instructions:
      - text: List tiers matching {filter}.
        slots:
          filter: query.filter
      - text: Show me page {page} of tiers, {limit} at a time.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tiers/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a membership tier
      effect: write
      questions:
      - How do I add a new paid tier with its own price?
      - Can I list benefits when I create a tier?
      instructions:
      - text: Create tier {tiers}.
        slots:
          tiers: requestBody.tiers
      - text: Add a new membership tier with pricing from {tiers}.
        slots:
          tiers: requestBody.tiers
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tiers/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a membership tier by ID
      effect: read
      questions:
      - How do I look up one tier's price and benefits?
      - Can I fetch a tier by its ID?
      instructions:
      - text: Get tier {id}.
        slots:
          id: path.id
      - text: Show tier {id} with only {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tiers/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a membership tier
      effect: write
      questions:
      - How do I change a tier's price or benefits?
      - Can I change whether a tier is visible?
      instructions:
      - text: Update tier {id} with {tiers}.
        slots:
          id: path.id
          tiers: requestBody.tiers
      - text: Hide membership tier {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'