Ghost · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/ghost-org-content-posts-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/posts/'].get
$.paths['/content/posts/{id}/'].get
$.paths['/content/posts/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 - Posts API
  version: 1.0.0
extends: openapi/ghost-org-content-posts-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/posts/'].get
  update:
    x-apievangelist-phrasing:
      intent: List published posts
      effect: read
      questions:
      - How do I pull my latest published posts into a website or app?
      - Can I filter published posts by tag or author?
      - Is it possible to get posts with plaintext or HTML content?
      instructions:
      - text: List published posts matching {filter}.
        slots:
          filter: query.filter
      - text: Get the {limit} newest posts ordered by {order}.
        slots:
          limit: query.limit
          order: query.order
      - text: List published posts with {include} in {formats} format.
        slots:
          include: query.include
          formats: query.formats
      method: generated
      generated: '2026-09-26'
- target: $.paths['/content/posts/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a published post by ID
      effect: read
      questions:
      - How do I load one published post by its ID?
      - Can I get a post's authors and tags in the same request?
      instructions:
      - text: Get published post {id}.
        slots:
          id: path.id
      - text: Load post {id} with {include}.
        slots:
          id: path.id
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/content/posts/slug/{slug}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a published post by slug
      effect: read
      questions:
      - How do I render a blog article from the slug in its URL?
      - Can I fetch a public post by slug and include its tags?
      instructions:
      - text: Get the published post with slug {slug}.
        slots:
          slug: path.slug
      - text: Load article {slug} along with {include}.
        slots:
          slug: path.slug
          include: query.include
      method: generated
      generated: '2026-09-26'