Ghost · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ghost Admin Members API

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

$.info

$.paths['/members/'].get

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

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

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

$.paths['/members/{id}/'].delete

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 Members API
  version: 1.0.0
extends: openapi/ghost-org-members-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: 5
- target: $.paths['/members/'].get
  update:
    x-apievangelist-phrasing:
      intent: List and filter members
      effect: read
      questions:
      - How do I find all my paid members?
      - Can I filter members by label or newsletter subscription?
      - What order can I sort the member list in?
      instructions:
      - text: List members matching {filter}.
        slots:
          filter: query.filter
      - text: Show me {limit} members ordered by {order}.
        slots:
          limit: query.limit
          order: query.order
      - text: Get page {page} of members.
        slots:
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/members/'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new member
      effect: write
      questions:
      - How do I add a subscriber to my site by email?
      - Can I sign someone up to newsletters when I create them as a member?
      instructions:
      - text: Create member {members}.
        slots:
          members: requestBody.members
      - text: Add a new member with email and labels from {members}.
        slots:
          members: requestBody.members
      method: generated
      generated: '2026-09-26'
- target: $.paths['/members/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a member by ID
      effect: read
      questions:
      - How do I pull up one member's record from their ID?
      - Can I fetch only certain fields for a single member?
      instructions:
      - text: Get member {id}.
        slots:
          id: path.id
      - text: Show member {id} with only {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/members/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a member
      effect: write
      questions:
      - How do I change a member's email or note?
      - Can I change which newsletters an existing member gets?
      instructions:
      - text: Update member {id} with {members}.
        slots:
          id: path.id
          members: requestBody.members
      - text: Add a label to member {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/members/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a member
      effect: destructive
      questions:
      - How do I permanently remove a member from my site?
      - Is deleting a member reversible?
      instructions:
      - text: Delete member {id}.
        slots:
          id: path.id
      - text: Permanently remove member {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'