Akuity · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Akuity Platform API — Auth Auth Service API

5 actions 5 updates phrasing extends openapi/akuity-auth-service-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/api/v1/auth/device-code'].get

$.paths['/api/v1/auth/device-token'].post

$.paths['/api/v1/auth/refresh-token'].post

$.paths['/api/v1/oidc/provider-details'].get

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 Akuity Platform API — Auth Auth Service API
  version: 1.0.0
extends: openapi/akuity-auth-service-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: 4
- target: $.paths['/api/v1/auth/device-code'].get
  update:
    x-apievangelist-phrasing:
      intent: Start a device login and get a device code
      effect: read
      questions:
      - How does a CLI start the device login flow for the Akuity Platform?
      - Where do I get a device code to sign in from a headless machine?
      instructions:
      - text: Start a device login and give me the device code.
      - text: Request a new device authorization code.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/auth/device-token'].post
  update:
    x-apievangelist-phrasing:
      intent: Exchange a device code for a token
      effect: write
      questions:
      - After approving a device login, how do I get the access token?
      - Can I poll with my device code until the sign-in completes?
      instructions:
      - text: Exchange device code {device_code} for an access token.
        slots:
          device_code: requestBody.deviceCode
      - text: Poll for the token issued to device code {device_code}.
        slots:
          device_code: requestBody.deviceCode
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/auth/refresh-token'].post
  update:
    x-apievangelist-phrasing:
      intent: Refresh an access token
      effect: write
      questions:
      - My session token expired; how do I refresh it?
      - Can I renew an access token without logging in again?
      instructions:
      - text: Refresh my access token.
      - text: Renew the current session's token before it expires.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/oidc/provider-details'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up OIDC provider details from a discovery URL
      effect: read
      questions:
      - Can the platform read my identity provider's OIDC discovery document?
      - What issuer and endpoints does an OIDC discovery URL resolve to?
      instructions:
      - text: Get OIDC provider details for discovery URL {discovery_url}.
        slots:
          discovery_url: query.discoveryUrl
      - text: Resolve the identity provider behind {discovery_url}.
        slots:
          discovery_url: query.discoveryUrl
      method: generated
      generated: '2026-10-01'