Ghost · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/ghost-org-content-tags-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/tags/'].get

$.paths['/content/tags/{id}/'].get

$.paths['/content/tags/slug/{slug}/'].get

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 Content and Admin Content - Tags API
  version: 1.0.0
extends: openapi/ghost-org-content-tags-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/tags/'].get
  update:
    x-apievangelist-phrasing:
      intent: List public tags
      effect: read
      questions:
      - How do I list the public tags for a topics menu?
      - Can I include how many posts use each tag?
      instructions:
      - text: List public tags with {include}.
        slots:
          include: query.include
      - text: Get page {page} of tags, {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/content/tags/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a public tag by ID
      effect: read
      questions:
      - How do I load one public tag by ID?
      - What does a public tag record include?
      instructions:
      - text: Get public tag {id}.
        slots:
          id: path.id
      - text: Show the tag {id} and its description.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/content/tags/slug/{slug}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a public tag by slug
      effect: read
      questions:
      - How do I build a tag archive page from the slug in the URL?
      - Can I fetch a tag by slug instead of ID?
      instructions:
      - text: Get the public tag with slug {slug}.
        slots:
          slug: path.slug
      - text: Load tag {slug} for its archive page.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-09-26'