Thanx · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thanx Partner Metadata API

4 actions 4 updates phrasing extends openapi/thanx-metadata-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 4

$.info

$.paths['/partner/metadata/merchants'].get

$.paths['/partner/metadata/locations'].get

$.paths['/partner/metadata/scopes'].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 Partner Metadata API
  version: 1.0.0
extends: openapi/thanx-metadata-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['/partner/metadata/merchants'].get
  update:
    x-apievangelist-phrasing:
      intent: List merchants the partner can access
      effect: read
      questions:
      - Which merchants does my partner integration have access to?
      - How do I find the merchant IDs available to my partner account?
      instructions:
      - text: List the merchants my partner account can access.
      - text: Show me all accessible merchants and their IDs.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partner/metadata/locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List locations the partner can access
      effect: read
      questions:
      - Which locations can my partner integration work with?
      - Can I limit the partner's accessible locations to one merchant?
      instructions:
      - text: List partner-accessible locations for merchant {merchant_id}.
        slots:
          merchant_id: query.merchant_id
      - text: Show every location my partner account has access to.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partner/metadata/scopes'].get
  update:
    x-apievangelist-phrasing:
      intent: List the partner's OAuth scopes
      effect: read
      questions:
      - What OAuth scopes are available to my partner account?
      - Does my partner integration have permission for a given scope?
      instructions:
      - text: List the OAuth scopes available to my partner account.
      - text: Show which scopes my partner credentials are granted.
      method: generated
      generated: '2026-09-26'