Ghost · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/admin/tags/'].get
$.paths['/admin/tags/'].post
$.paths['/admin/tags/{id}/'].put
$.paths['/admin/tags/{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 - Tags API
  version: 1.0.0
extends: openapi/ghost-org-admin-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: 4
- target: $.paths['/admin/tags/'].get
  update:
    x-apievangelist-phrasing:
      intent: List tags
      effect: read
      questions:
      - What tags do I have on my site?
      - How do I page through a long list of tags?
      instructions:
      - text: List all my tags.
      - text: Show me page {page} of tags, {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/tags/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tag
      effect: write
      questions:
      - How do I create a new tag for organizing posts?
      - Can I add a tag before any post uses it?
      instructions:
      - text: Create a tag from {tags}.
        slots:
          tags: requestBody.tags
      - text: Add a new tag called Tutorials.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/tags/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a tag
      effect: write
      questions:
      - Can I rename a tag or change its description?
      - How do I edit an existing tag?
      instructions:
      - text: Update tag {id} with {tags}.
        slots:
          id: path.id
          tags: requestBody.tags
      - text: Rename tag {id} to Guides.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/tags/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag
      effect: destructive
      questions:
      - How do I get rid of a tag I don't use anymore?
      - Is removing a tag permanent?
      instructions:
      - text: Delete tag {id}.
        slots:
          id: path.id
      - text: Remove the tag {id} from my site.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'