Ghost · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ghost Content Authors API

4 actions 4 updates phrasing extends openapi/ghost-org-authors-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['/authors/'].get
$.paths['/authors/{id}/'].get
$.paths['/authors/slug/{slug}/'].get

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 Authors API
  version: 1.0.0
extends: openapi/ghost-org-authors-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['/authors/'].get
  update:
    x-apievangelist-phrasing:
      intent: List authors
      effect: read
      questions:
      - Who writes for this publication?
      - Can I see how many posts each author has published?
      - How do I sort or filter the list of authors?
      instructions:
      - text: List all authors with {include}.
        slots:
          include: query.include
      - text: Show me authors matching {filter}, ordered by {order}.
        slots:
          filter: query.filter
          order: query.order
      - text: Get page {page} of authors, {limit} at a time.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/authors/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an author by ID
      effect: read
      questions:
      - How do I get one author's profile if I have their ID?
      - Can I get an author's post count along with their profile?
      instructions:
      - text: Get author {id}.
        slots:
          id: path.id
      - text: Show me author {id} including {include}.
        slots:
          id: path.id
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/authors/slug/{slug}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an author by slug
      effect: read
      questions:
      - How do I find an author from their profile URL slug?
      - Can I look up a writer by slug instead of ID?
      instructions:
      - text: Get the author with slug {slug}.
        slots:
          slug: path.slug
      - text: Look up author {slug} and return only {fields}.
        slots:
          slug: path.slug
          fields: query.fields
      method: generated
      generated: '2026-09-26'