Thanx · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Thanx Partner Issuance Jobs API

3 actions 3 updates phrasing extends openapi/thanx-issuance-jobs-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 3

$.info
$.paths['/partner/issuance_jobs/{id}'].get
$.paths['/partner/issuance_jobs/{id}/revoke'].post

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 Thanx Partner Issuance Jobs API
  version: 1.0.0
extends: openapi/thanx-issuance-jobs-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: 2
- target: $.paths['/partner/issuance_jobs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a reward issuance job's status
      effect: read
      questions:
      - Has my bulk reward issuance finished processing yet?
      - How do I check the progress of a reward issuance job?
      instructions:
      - text: Get the status of issuance job {id}.
        slots:
          id: path.id
      - text: Check whether reward issuance job {id} is complete.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/partner/issuance_jobs/{id}/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke a reward issuance job
      effect: destructive
      questions:
      - Can I take back rewards that were issued by mistake in a bulk job?
      - How do I revoke a reward issuance job?
      instructions:
      - text: Revoke issuance job {id}.
        slots:
          id: path.id
      - text: Undo the rewards handed out by issuance job {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'