Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Platform Internal API

2 actions 2 updates phrasing extends openapi/canonical-internal-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 2

$.info
$.paths['/api/v0/tenants/lookup'].get

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 Identity Platform Internal API
  version: 1.0.0
extends: openapi/canonical-internal-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: 1
- target: $.paths['/api/v0/tenants/lookup'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up tenants for a user
      effect: read
      questions:
      - Which tenants does a user with a given email belong to?
      - Can I find tenants from an identity ID in the Identity Platform?
      instructions:
      - text: Look up tenants for email {email}.
        slots:
          email: query.email
      - text: Find the tenants linked to identity {identity_id}.
        slots:
          identity_id: query.identity_id
      method: generated
      generated: '2026-09-26'