Ghost · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ghost Admin Newsletters API

5 actions 5 updates phrasing extends openapi/ghost-org-newsletters-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['/newsletters/'].get

$.paths['/newsletters/'].post

$.paths['/newsletters/{id}/'].get

$.paths['/newsletters/{id}/'].put

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 Ghost Admin Newsletters API
  version: 1.0.0
extends: openapi/ghost-org-newsletters-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['/newsletters/'].get
  update:
    x-apievangelist-phrasing:
      intent: List newsletters
      effect: read
      questions:
      - What newsletters does my publication send?
      - Can I filter newsletters to only the active ones?
      instructions:
      - text: List newsletters matching {filter}.
        slots:
          filter: query.filter
      - text: Show me all newsletters ordered by {order}.
        slots:
          order: query.order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/newsletters/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a newsletter
      effect: write
      questions:
      - How do I launch a new newsletter with its own sender name?
      - Can I customize the design of a newsletter when I create it?
      instructions:
      - text: Create newsletter {newsletters}.
        slots:
          newsletters: requestBody.newsletters
      - text: Set up a new newsletter using {newsletters}.
        slots:
          newsletters: requestBody.newsletters
      method: generated
      generated: '2026-09-26'
- target: $.paths['/newsletters/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a newsletter by ID
      effect: read
      questions:
      - How do I see the settings of one newsletter?
      - Can I look up a newsletter by its ID?
      instructions:
      - text: Get newsletter {id}.
        slots:
          id: path.id
      - text: Show newsletter {id} with only {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/newsletters/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a newsletter
      effect: write
      questions:
      - How do I change the sender email of an existing newsletter?
      - Can I edit the design of a newsletter I already have?
      instructions:
      - text: Update newsletter {id} with {newsletters}.
        slots:
          id: path.id
          newsletters: requestBody.newsletters
      - text: Change the sender name on newsletter {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'