Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Test Observer Authentication API

6 actions 6 updates phrasing extends openapi/canonical-authentication-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 6

$.info

$.paths['/v1/auth/saml/login'].get

$.paths['/v1/auth/saml/logout'].get

$.paths['/v1/auth/saml/acs'].post

$.paths['/v1/auth/saml/sls'].get

$.paths['/v1/auth/saml/sls'].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 Test Observer Authentication API
  version: 1.0.0
extends: openapi/canonical-authentication-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/v1/auth/saml/login'].get
  update:
    x-apievangelist-phrasing:
      intent: Start a SAML single sign-on login
      effect: read
      questions:
      - How do I sign in with SAML single sign-on?
      - Can I send the user back to a specific page after SAML login?
      instructions:
      - text: Start a SAML login and return me to {return_to}.
        slots:
          return_to: query.return_to
      - text: Begin SAML sign-in through the identity provider.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/auth/saml/logout'].get
  update:
    x-apievangelist-phrasing:
      intent: Start a SAML logout
      effect: write
      questions:
      - How do I log out of a SAML session?
      - Where does the user land after a SAML sign-out?
      instructions:
      - text: Log me out via SAML and return to {return_to}.
        slots:
          return_to: query.return_to
      - text: End my SAML single sign-on session.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/auth/saml/acs'].post
  update:
    x-apievangelist-phrasing:
      intent: Receive the SAML login assertion
      effect: write
      questions:
      - Which endpoint is the SAML assertion consumer service?
      - Where does the identity provider post the login response?
      instructions:
      - text: Post the identity provider's SAML login assertion to the ACS.
      - text: Complete the SAML login callback.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/auth/saml/sls'].get
  update:
    x-apievangelist-phrasing:
      intent: Handle a SAML logout redirect
      effect: write
      questions:
      - Which URL handles a SAML single logout redirect?
      - How is a redirect-binding SAML logout response processed?
      instructions:
      - text: Process the SAML single logout redirect.
      - text: Handle the logout response the IdP redirected back.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/auth/saml/sls'].post
  update:
    x-apievangelist-phrasing:
      intent: Handle a posted SAML logout response
      effect: write
      questions:
      - Can the identity provider post the SAML logout response instead of redirecting?
      - What endpoint accepts a POST-binding single logout message?
      instructions:
      - text: Post the SAML single logout message to the SLS.
      - text: Complete the POST-binding logout callback.
      method: generated
      generated: '2026-09-26'