Punchh · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Online Ordering and SSO User Management API

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

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/api/auth/users/forgot_password'].post
$.paths['/api/auth/users'].get
$.paths['/api/auth/users'].put
$.paths['/api/auth/accounts'].get
$.paths['/api/auth/users/change_password'].patch
$.paths['/api/auth/user_enrollments'].post
$.paths['/api/auth/user_enrollments'].delete

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 Online Ordering and SSO User Management API
  version: 1.0.0
extends: openapi/punchh-user-management-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/api/auth/users/forgot_password'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a guest a password reset email
      effect: write
      questions:
      - How does a guest on the web ordering site reset a forgotten password?
      - Can I trigger the reset-password email for a guest through SSO?
      instructions:
      - text: Send a password reset link to {user}.
        slots:
          user: requestBody.user
      - text: Email guest {user} a link to reset their password.
        slots:
          user: requestBody.user
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/users'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a signed-in guest's profile details
      effect: read
      questions:
      - Can I read a guest's birthday, anniversary and zip code after SSO login?
      - What profile fields come back for an authenticated web guest?
      instructions:
      - text: Fetch the profile for authentication token {auth_token}.
        slots:
          auth_token: requestBody.authentication_token
      - text: Show my birthday, anniversary and zip code on file.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/users'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a guest's profile or password
      effect: write
      questions:
      - Can a guest change their name or anniversary from the website?
      - Is a guest's birthday editable more than once?
      instructions:
      - text: Update my profile with {user}.
        slots:
          user: requestBody.user
      - text: Change the name and anniversary for session {auth_token} to {user}.
        slots:
          auth_token: requestBody.authentication_token
          user: requestBody.user
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/accounts'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a guest's account history
      effect: read
      questions:
      - Where can a web guest see their check-ins and other loyalty events?
      - What date format does the account history use for event expiry?
      instructions:
      - text: Show the account history for token {auth_token}.
        slots:
          auth_token: requestBody.authentication_token
      - text: List my past loyalty events.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/users/change_password'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change a guest's password without the old one
      effect: write
      questions:
      - Can a guest set a new password without entering their current one?
      - How do I use a reset password token to change a password?
      instructions:
      - text: Change the password using reset token {reset_token} to {user}.
        slots:
          reset_token: requestBody.reset_password_token
          user: requestBody.user
      - text: Set a new password {user} for session {auth_token}.
        slots:
          user: requestBody.user
          auth_token: requestBody.authentication_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/user_enrollments'].post
  update:
    x-apievangelist-phrasing:
      intent: Enroll a guest in a social cause campaign
      effect: write
      questions:
      - Can a guest join a charity campaign from the web ordering site?
      - What item type is used when enrolling in a social cause campaign?
      instructions:
      - text: Enroll me in {item_type} campaign {item_id}.
        slots:
          item_type: requestBody.item_type
          item_id: requestBody.item_id
      - text: Join social cause campaign {item_id} for session {auth_token}.
        slots:
          item_id: requestBody.item_id
          auth_token: requestBody.authentication_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/auth/user_enrollments'].delete
  update:
    x-apievangelist-phrasing:
      intent: Disenroll a guest from a campaign
      effect: destructive
      questions:
      - How does a web guest leave a social cause campaign?
      - Can I remove a guest from a campaign they joined?
      instructions:
      - text: Disenroll me from {item_type} campaign {item_id}.
        slots:
          item_type: requestBody.item_type
          item_id: requestBody.item_id
      - text: Leave social cause campaign {item_id} for session {auth_token}.
        slots:
          item_id: requestBody.item_id
          auth_token: requestBody.authentication_token
      method: generated
      generated: '2026-10-01'