Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Platform Authentication Service API

5 actions 5 updates phrasing extends openapi/canonical-authentication-service-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info

$.paths['/api/v0/auth'].get

$.paths['/api/v0/auth/callback'].get

$.paths['/api/v0/auth/logout'].get

$.paths['/api/v0/auth/me'].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 Identity Platform Authentication Service API
  version: 1.0.0
extends: openapi/canonical-authentication-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/v0/auth'].get
  update:
    x-apievangelist-phrasing:
      intent: Start a login to the identity platform admin
      effect: read
      questions:
      - How do I sign in to the identity platform admin UI?
      - Can I send users back to a specific page after they log in?
      instructions:
      - text: Start the login flow.
      - text: Log me in and redirect to {next} afterwards.
        slots:
          next: query.next
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/auth/callback'].get
  update:
    x-apievangelist-phrasing:
      intent: Complete the login callback
      effect: read
      questions:
      - What handles the authorization code returned after sign-in?
      - Which values does the login callback expect from the identity provider?
      instructions:
      - text: Complete login with authorization code {code} and state {state}.
        slots:
          code: query.code
          state: query.state
      - text: Finish the sign-in callback for code {code} with scope {scope}.
        slots:
          code: query.code
          scope: query.scope
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/auth/logout'].get
  update:
    x-apievangelist-phrasing:
      intent: Log out of the identity platform admin
      effect: write
      questions:
      - How do I sign out of the admin session?
      - Can logout send me to a chosen page afterwards?
      instructions:
      - text: Log me out.
      - text: End my session and redirect to {next}.
        slots:
          next: query.next
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v0/auth/me'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the signed-in user's profile
      effect: read
      questions:
      - Who am I signed in as?
      - What profile details does the admin session hold for me?
      instructions:
      - text: Show my current user profile.
      - text: Tell me which account this session is logged in with.
      method: generated
      generated: '2026-10-01'