Ghost · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Ghost Org Tags API

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

$.info

$.paths['/tags/'].get

$.paths['/tags/'].post

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

$.paths['/tags/{id}/'].put

$.paths['/tags/{id}/'].delete

$.paths['/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 Org Tags API
  version: 1.0.0
extends: openapi/ghost-org-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: 6
- target: $.paths['/tags/'].get
  update:
    x-apievangelist-phrasing:
      intent: List tags including internal
      effect: read
      questions:
      - How do I list all tags, including internal ones?
      - Can I filter or sort the tag list?
      instructions:
      - text: List tags matching {filter}.
        slots:
          filter: query.filter
      - text: Show me {limit} tags ordered by {order}.
        slots:
          limit: query.limit
          order: query.order
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tag
      effect: write
      questions:
      - How do I create a new tag?
      - How do I make an internal tag that readers won't see?
      instructions:
      - text: Create tag {tags}.
        slots:
          tags: requestBody.tags
      - text: Add an internal hash tag using {tags}.
        slots:
          tags: requestBody.tags
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tag by ID
      effect: read
      questions:
      - How do I look up one tag by ID?
      - Can I get only certain fields for a tag?
      instructions:
      - text: Get tag {id}.
        slots:
          id: path.id
      - text: Show tag {id} with only {fields}.
        slots:
          id: path.id
          fields: query.fields
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a tag
      effect: write
      questions:
      - How do I rename an existing tag?
      - Can I change a tag's description or slug?
      instructions:
      - text: Update tag {id} with {tags}.
        slots:
          id: path.id
          tags: requestBody.tags
      - text: Rename tag {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag
      effect: destructive
      questions:
      - How do I permanently delete a tag?
      - Can a deleted tag be brought back?
      instructions:
      - text: Delete tag {id}.
        slots:
          id: path.id
      - text: Permanently remove tag {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/tags/slug/{slug}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a tag by slug
      effect: read
      questions:
      - How do I find a tag from its URL slug?
      - Can I see how many posts use a tag I know by slug?
      instructions:
      - text: Get the tag with slug {slug}.
        slots:
          slug: path.slug
      - text: Look up tag {slug} with {include}.
        slots:
          slug: path.slug
          include: query.include
      method: generated
      generated: '2026-09-26'