Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Testflinger Oidc API

3 actions 3 updates phrasing extends openapi/canonical-oidc-api-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 3

$.info
$.paths['/oidc/auth-init'].post
$.paths['/oidc/auth-poll/{request_id}'].post

OpenAPI Overlay

Raw ↑ 
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Testflinger Oidc API
  version: 1.0.0
extends: openapi/canonical-oidc-api-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: 2
- target: $.paths['/oidc/auth-init'].post
  update:
    x-apievangelist-phrasing:
      intent: Start an OIDC sign-in
      effect: write
      questions:
      - How does a client begin authenticating through the OIDC provider?
      - Which parameters do I get back to start an OIDC login?
      instructions:
      - text: Start an OIDC authentication request.
      - text: Initiate OIDC sign-in and give me the parameters to authenticate.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/oidc/auth-poll/{request_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Poll for an OIDC sign-in result
      effect: read
      questions:
      - Has my OIDC login finished yet?
      - Can I get the user info once OIDC authentication succeeds?
      instructions:
      - text: Poll for the OIDC result of request {request_id}.
        slots:
          request_id: path.request_id
      - text: Check whether OIDC request {request_id} has authenticated.
        slots:
          request_id: path.request_id
      method: generated
      generated: '2026-10-01'