Stax · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for stax-api Admin API

2 actions 2 updates phrasing extends openapi/stax-admin-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Stax's API. It is a proposal applied on top of the contract, not a document Stax publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/admin/enroll'].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 stax-api Admin API
  version: 1.0.0
extends: openapi/stax-admin-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: 1
- target: $.paths['/admin/enroll'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll a merchant, registration and user at once
      effect: write
      questions:
      - Can I create a merchant, its registration and its first user login in a single Stax request?
      - Is there a one-step way to onboard a new merchant together with their user account?
      - Can I skip the account page when enrolling a new merchant?
      instructions:
      - text: Enroll merchant {merchant} with user {user} and registration {registration} in one request.
        slots:
          merchant: requestBody.merchant
          user: requestBody.user
          registration: requestBody.registration
      - text: 'Enroll merchant {merchant} and hide the prefilled fields on their registration: {hide_prefilled_fields}.'
        slots:
          merchant: requestBody.merchant
          hide_prefilled_fields: requestBody.hide_prefilled_fields
      method: generated
      generated: '2026-09-26'