Stax · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for stax-api Reset API

3 actions 3 updates phrasing extends openapi/stax-reset-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 3

$.info
$.paths['/reset/{token}'].get
$.paths['/reset/{token}'].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 Reset API
  version: 1.0.0
extends: openapi/stax-reset-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['/reset/{token}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a password reset token
      effect: read
      questions:
      - Is a password reset link's token still valid before I show the reset form?
      - Can I verify a reset token from the URL without changing the password?
      instructions:
      - text: Check whether password reset token {token} is valid.
        slots:
          token: path.token
      - text: Verify reset token {token} before showing the new-password form.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-26'
- target: $.paths['/reset/{token}'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a new password with a reset token
      effect: write
      questions:
      - Can a user choose a new password once they have a reset token?
      - What is required to complete a password reset?
      instructions:
      - text: Reset the password with token {token} to {password}, confirmed as {password_confirmation}.
        slots:
          token: path.token
          password: query.password
          password_confirmation: query.password_confirmation
      - text: Complete password reset {token} using new password {password} and confirmation {password_confirmation}.
        slots:
          token: path.token
          password: query.password
          password_confirmation: query.password_confirmation
      method: generated
      generated: '2026-09-26'