Ghost · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/admin/pages/'].get
$.paths['/admin/pages/'].post
$.paths['/admin/pages/{id}/'].get
$.paths['/admin/pages/{id}/'].put
$.paths['/admin/pages/{id}/'].delete

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 Admin - Pages API
  version: 1.0.0
extends: openapi/ghost-org-admin-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: 5
- target: $.paths['/admin/pages/'].get
  update:
    x-apievangelist-phrasing:
      intent: List pages including drafts
      effect: read
      questions:
      - How do I list all the static pages on my site, drafts included?
      - Can I filter pages, for example only published ones?
      instructions:
      - text: List pages matching {filter}.
        slots:
          filter: query.filter
      - text: Show me page {page} of my site's pages, {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/pages/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a page
      effect: write
      questions:
      - How do I create a new static page like an About page?
      - Can I send the page body as HTML instead of Lexical?
      instructions:
      - text: Create a new page from {pages}.
        slots:
          pages: requestBody.pages
      - text: Create a page using {source} content.
        slots:
          source: query.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/pages/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a page by ID
      effect: read
      questions:
      - How do I fetch one page by its ID, even if it's a draft?
      - What does a single page record look like?
      instructions:
      - text: Get page {id}.
        slots:
          id: path.id
      - text: Show me the details of page {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/pages/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a page
      effect: write
      questions:
      - How do I edit an existing static page's content?
      - Can I update a page using HTML for the body?
      instructions:
      - text: Update page {id} with {pages}.
        slots:
          id: path.id
          pages: requestBody.pages
      - text: Edit page {id} and send the body as {source}.
        slots:
          id: path.id
          source: query.source
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/pages/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a page
      effect: destructive
      questions:
      - How do I remove a static page from my site?
      - Is deleting a page permanent?
      instructions:
      - text: Delete page {id}.
        slots:
          id: path.id
      - text: Remove the page {id} from the site.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'