Emboss · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Getemboss Ai OAuth API

6 actions 6 updates phrasing extends openapi/getemboss-ai-oauth-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 6

$.info

$.paths['/oauth/{_rest}'].options

$.paths['/oauth/register'].post

$.paths['/oauth/authorize'].get

$.paths['/oauth/token'].post

$.paths['/oauth/revoke'].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 OAuth API
  version: 1.0.0
extends: openapi/getemboss-ai-oauth-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: 5
- target: $.paths['/oauth/{_rest}'].options
  update:
    x-apievangelist-phrasing:
      intent: Answer CORS preflight for OAuth routes
      effect: read
      questions:
      - Do the OAuth endpoints support CORS preflight requests from browsers?
      - Which origins and methods are allowed on the OAuth paths?
      instructions:
      - text: Send a CORS preflight for OAuth path {_rest}.
        slots:
          _rest: path._rest
      - text: Check which methods the OAuth route {_rest} allows cross-origin.
        slots:
          _rest: path._rest
      method: generated
      generated: '2026-10-01'
- target: $.paths['/oauth/register'].post
  update:
    x-apievangelist-phrasing:
      intent: Register an OAuth client dynamically
      effect: write
      questions:
      - How does an MCP client register itself for OAuth?
      - Is dynamic client registration supported?
      instructions:
      - text: Register a new OAuth client.
      - text: Dynamically register my app as an OAuth client.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/oauth/authorize'].get
  update:
    x-apievangelist-phrasing:
      intent: Start the OAuth authorization flow
      effect: read
      questions:
      - Where do I send a user to grant my app access to their account?
      - What's the authorization endpoint for connecting an agent?
      instructions:
      - text: Start OAuth authorization for my client.
      - text: Open the consent page so the user can authorize my app.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/oauth/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange an OAuth code for tokens
      effect: write
      questions:
      - How do I turn an authorization code into an access token?
      - Can I refresh an expired OAuth access token?
      instructions:
      - text: Exchange my authorization code for an access token.
      - text: Request a fresh OAuth access token.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/oauth/revoke'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke an OAuth token
      effect: destructive
      questions:
      - How does a client revoke an OAuth token it holds?
      - Can I invalidate an access or refresh token when a user disconnects?
      instructions:
      - text: Revoke my OAuth token.
      - text: Invalidate the client's refresh token now.
      method: generated
      generated: '2026-10-01'