Canonical · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Identity Platform App Authorization Service API

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

$.info

$.paths['/api/v0/authz/apps/{app_id}/groups'].get

$.paths['/api/v0/authz/apps/{app_id}/groups'].delete

$.paths['/api/v0/authz/groups/{group_id}/apps'].get

$.paths['/api/v0/authz/groups/{group_id}/apps'].post

$.paths['/api/v0/authz/groups/{group_id}/apps'].delete

$.paths['/api/v0/authz/groups/{group_id}/apps/{app_id}'].delete

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 App Authorization Service API
  version: 1.0.0
extends: openapi/canonical-appauthorizationservice-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: 6
- target: $.paths['/api/v0/authz/apps/{app_id}/groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List groups an app is allowed in
      effect: read
      questions:
      - Which groups is a given OAuth app allowed to be used in?
      - Can I check where a client app has been authorized?
      instructions:
      - text: List the groups app {app_id} is allowed in.
        slots:
          app_id: path.app_id
      - text: Show every group that authorizes app {app_id}.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/authz/apps/{app_id}/groups'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an app from every group
      effect: destructive
      questions:
      - How do I revoke an app's access from all groups at once?
      - Can I strip every group authorization from a single app?
      instructions:
      - text: Remove app {app_id} from all groups it is allowed in.
        slots:
          app_id: path.app_id
      - text: Revoke every group authorization for app {app_id}.
        slots:
          app_id: path.app_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/authz/groups/{group_id}/apps'].get
  update:
    x-apievangelist-phrasing:
      intent: List apps allowed in a group
      effect: read
      questions:
      - Which apps are members of a group's allowed list?
      - What client apps can the members of a group use?
      instructions:
      - text: List the apps allowed in group {group_id}.
        slots:
          group_id: path.group_id
      - text: Show the allowed-apps list of group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/authz/groups/{group_id}/apps'].post
  update:
    x-apievangelist-phrasing:
      intent: Allow an app in a group
      effect: write
      questions:
      - How do I authorize a client app for a group?
      - Can I add an OAuth client to a group's allowed list by its client ID?
      instructions:
      - text: Allow client {client_id} in group {group_id}.
        slots:
          client_id: requestBody.client_id
          group_id: path.group_id
      - text: Add app {client_id} to the allowed list of group {group_id}.
        slots:
          client_id: requestBody.client_id
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/authz/groups/{group_id}/apps'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove all apps from a group
      effect: destructive
      questions:
      - Can I clear a group's entire allowed-apps list in one go?
      - How do I revoke every app from one group?
      instructions:
      - text: Remove all apps from the allowed list of group {group_id}.
        slots:
          group_id: path.group_id
      - text: Clear every allowed app from group {group_id}.
        slots:
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v0/authz/groups/{group_id}/apps/{app_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one app from a group
      effect: destructive
      questions:
      - How do I take a single app off a group's allowed list?
      - Can I revoke one client app from one group without touching the others?
      instructions:
      - text: Remove app {app_id} from group {group_id}.
        slots:
          app_id: path.app_id
          group_id: path.group_id
      - text: Revoke app {app_id}'s authorization in group {group_id} only.
        slots:
          app_id: path.app_id
          group_id: path.group_id
      method: generated
      generated: '2026-09-26'