Thanx · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thanx Users API

5 actions 5 updates phrasing extends openapi/thanx-users-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Thanx's API. It is a proposal applied on top of the contract, not a document Thanx publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/users/me'].get

$.paths['/users'].post

$.paths['/partner/users/{id}'].get

$.paths['/partner/users'].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 Thanx Users API
  version: 1.0.0
extends: openapi/thanx-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: 4
- target: $.paths['/users/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Get my own user profile
      effect: read
      questions:
      - What profile details does my signed-in loyalty account have?
      - Can I see my own Thanx user profile?
      instructions:
      - text: Show my user profile.
      - text: Get the profile of the currently signed-in user.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign up a new user
      effect: write
      questions:
      - How do I sign up a new member for the loyalty program?
      - Does creating a user also return an authorization grant?
      instructions:
      - text: Create a new user with {user}.
        slots:
          user: requestBody.user
      - text: 'Sign up this person as a loyalty member: {user}.'
        slots:
          user: requestBody.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partner/users/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a user by ID as a partner
      effect: read
      questions:
      - How can a partner look up a specific loyalty member by ID?
      - What information is available about one user from the partner side?
      instructions:
      - text: Get user {id}.
        slots:
          id: path.id
      - text: Look up loyalty member {id} from the partner account.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partner/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List a merchant's users
      effect: read
      questions:
      - Which loyalty members belong to a merchant?
      - Can I list all users enrolled with one brand?
      instructions:
      - text: List users for merchant {merchant_id}.
        slots:
          merchant_id: query.merchant_id
      - text: Show every loyalty member my partner account can see.
      method: generated
      generated: '2026-09-26'