Emboss · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Getemboss Ai App API

4 actions 4 updates phrasing extends openapi/getemboss-ai-app-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Emboss's API. It is a proposal applied on top of the contract, not a document Emboss publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/app/login'].post

$.paths['/app/refresh'].post

$.paths['/app/logout'].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 Getemboss Ai App API
  version: 1.0.0
extends: openapi/getemboss-ai-app-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: 3
- target: $.paths['/app/login'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign in to the mobile app
      effect: write
      questions:
      - How does the app sign a user in with email and password?
      - Can I label the device when signing in to the app?
      instructions:
      - text: Sign in to the app as {email} with password {password}.
        slots:
          email: requestBody.email
          password: requestBody.password
      - text: Log {email} into the app on device {device_label} using {password}.
        slots:
          email: requestBody.email
          device_label: requestBody.device_label
          password: requestBody.password
      method: generated
      generated: '2026-10-01'
- target: $.paths['/app/refresh'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh an app session token
      effect: write
      questions:
      - What do I do when the app's access token expires?
      - Can a refresh token be exchanged for a new app session?
      instructions:
      - text: Refresh the app session with refresh token {refresh_token}.
        slots:
          refresh_token: requestBody.refresh_token
      - text: Get new app credentials using {refresh_token}.
        slots:
          refresh_token: requestBody.refresh_token
      method: generated
      generated: '2026-10-01'
- target: $.paths['/app/logout'].post
  update:
    x-apievangelist-phrasing:
      intent: Sign out of the app
      effect: destructive
      questions:
      - How do I sign a device out of the app?
      - Does logging out of the app invalidate the refresh token?
      instructions:
      - text: Log out of the app session for refresh token {refresh_token}.
        slots:
          refresh_token: requestBody.refresh_token
      - text: Revoke app refresh token {refresh_token} and sign the device out.
        slots:
          refresh_token: requestBody.refresh_token
      method: generated
      generated: '2026-10-01'