Stax · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for stax-api Forgot API

2 actions 2 updates phrasing extends openapi/stax-forgot-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['/forgot'].post

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 stax-api Forgot API
  version: 1.0.0
extends: openapi/stax-forgot-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['/forgot'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a password reset for a user
      effect: write
      questions:
      - What happens when a user forgets their Stax password?
      - Can I send a password reset link that lands on my own reset page URL?
      instructions:
      - text: Start a password reset for {email} and send them to {url}.
        slots:
          email: query.email
          url: query.url
      - text: Send a forgot-password email to {email} with reset page {url}.
        slots:
          email: query.email
          url: query.url
      method: generated
      generated: '2026-09-26'