Ghost · OpenAPI Overlay 1.0.0

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

4 actions 4 updates phrasing extends openapi/ghost-org-admin-users-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['/admin/users/'].get
$.paths['/admin/users/{id}/'].get
$.paths['/admin/users/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 Admin - Users API
  version: 1.0.0
extends: openapi/ghost-org-admin-users-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['/admin/users/'].get
  update:
    x-apievangelist-phrasing:
      intent: List staff users
      effect: read
      questions:
      - Who are the staff users on my Ghost site?
      - Can I see each staff user's role when listing them?
      instructions:
      - text: List all staff users.
      - text: List staff users and include {include}.
        slots:
          include: query.include
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/users/{id}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a staff user by ID
      effect: read
      questions:
      - How do I look up a staff member when I have their ID?
      - What details does one staff user record include?
      instructions:
      - text: Get staff user {id}.
        slots:
          id: path.id
      - text: Show me the profile of staff user {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/admin/users/slug/{slug}/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a staff user by slug
      effect: read
      questions:
      - How do I find a staff member using their profile slug?
      - Can I look up a staff user from their author page URL?
      instructions:
      - text: Get the staff user with slug {slug}.
        slots:
          slug: path.slug
      - text: Look up staff member {slug} by slug.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-09-26'