Ghost · OpenAPI Overlay 1.0.0

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

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

$.info

$.paths['/admin/newsletters/'].get

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

$.paths['/admin/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 Content and Admin Admin - Newsletters API
  version: 1.0.0
extends: openapi/ghost-org-admin-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: 3
- target: $.paths['/admin/newsletters/'].get
  update:
    x-apievangelist-phrasing:
      intent: List newsletters
      effect: read
      questions:
      - What newsletters are configured on my publication?
      - How do I see every newsletter members can subscribe to?
      instructions:
      - text: List all my newsletters.
      - text: Show me every newsletter set up on the site.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/newsletters/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a newsletter
      effect: write
      questions:
      - How do I start a second newsletter on my site?
      - Can I add a new newsletter for a separate weekly digest?
      instructions:
      - text: Create a new newsletter for a weekly digest.
      - text: Set up an additional newsletter on my publication.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/newsletters/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a newsletter
      effect: write
      questions:
      - Can I change the name or sender of an existing newsletter?
      - How do I edit the settings of a newsletter I already run?
      instructions:
      - text: Update newsletter {id}.
        slots:
          id: path.id
      - text: Rename newsletter {id} to Monthly Roundup.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'