Ghost · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/ghost-org-content-pages-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['/content/pages/'].get
$.paths['/content/pages/{id}/'].get
$.paths['/content/pages/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 and Admin Content - Pages API
  version: 1.0.0
extends: openapi/ghost-org-content-pages-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['/content/pages/'].get
  update:
    x-apievangelist-phrasing:
      intent: List published pages
      effect: read
      questions:
      - How do I pull the published static pages into my front-end?
      - Can I filter which public pages come back?
      instructions:
      - text: List published pages matching {filter}.
        slots:
          filter: query.filter
      - text: Get page {page} of published pages, {limit} at a time.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/content/pages/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a published page by ID
      effect: read
      questions:
      - How do I load a single published page by ID?
      - What content does a public page response contain?
      instructions:
      - text: Get published page {id}.
        slots:
          id: path.id
      - text: Load the public page {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/content/pages/slug/{slug}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a published page by slug
      effect: read
      questions:
      - How do I render a page like /about from its slug?
      - Can I fetch a public page by slug rather than ID?
      instructions:
      - text: Get the published page with slug {slug}.
        slots:
          slug: path.slug
      - text: Load page {slug} for display.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-09-26'