Ghost · OpenAPI Overlay 1.0.0

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

5 actions 5 updates phrasing extends openapi/ghost-org-admin-labels-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/labels/'].get
$.paths['/admin/labels/'].post
$.paths['/admin/labels/{id}/'].put
$.paths['/admin/labels/{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 - Labels API
  version: 1.0.0
extends: openapi/ghost-org-admin-labels-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/labels/'].get
  update:
    x-apievangelist-phrasing:
      intent: List member labels
      effect: read
      questions:
      - What labels have I set up for grouping my members?
      - Which member labels exist on my publication right now?
      instructions:
      - text: List every member label on my site.
      - text: Show me all the labels I can assign to members.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/labels/'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a member label
      effect: write
      questions:
      - How do I create a new label to segment my members?
      - Can I add a label like VIP before assigning it to anyone?
      instructions:
      - text: Create a new member label called VIP.
      - text: Add a label for conference attendees so I can tag members with it.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/labels/{id}/'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or update a member label
      effect: write
      questions:
      - Can I rename an existing member label without recreating it?
      - How do I change the name of a label I already use on members?
      instructions:
      - text: Rename member label {id} to Founding Supporters.
        slots:
          id: path.id
      - text: Update the member label {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/labels/{id}/'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a member label
      effect: destructive
      questions:
      - How do I remove a member label I no longer need?
      - What happens when I delete a label that's still applied to members?
      instructions:
      - text: Delete member label {id}.
        slots:
          id: path.id
      - text: Remove the unused label {id} from my site.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'