Ghost · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/admin/tiers/'].get
$.paths['/admin/tiers/'].post
$.paths['/admin/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 Content and Admin Admin - Tiers API
  version: 1.0.0
extends: openapi/ghost-org-admin-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: 3
- target: $.paths['/admin/tiers/'].get
  update:
    x-apievangelist-phrasing:
      intent: List membership tiers
      effect: read
      questions:
      - What membership tiers are set up on my site?
      - Can I include the monthly and yearly prices when listing tiers?
      instructions:
      - text: List all my membership tiers.
      - text: List tiers and include {include}.
        slots:
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/tiers/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a membership tier
      effect: write
      questions:
      - How do I add a new paid membership tier?
      - Can I create a premium tier alongside my existing one?
      instructions:
      - text: Create a new premium membership tier.
      - text: Add a paid tier for supporters.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/tiers/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a membership tier
      effect: write
      questions:
      - How do I change the name or benefits of a tier?
      - Can I edit an existing membership tier?
      instructions:
      - text: Update tier {id}.
        slots:
          id: path.id
      - text: Rename membership tier {id} to Gold.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'