Progress Software · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Chef Automate API Documentation Authorization API

4 actions 4 updates phrasing extends openapi/progress-software-authorization-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Progress Software's API. It is a proposal applied on top of the contract, not a document Progress Software publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/apis/iam/v2/introspect'].get
$.paths['/apis/iam/v2/introspect'].post
$.paths['/apis/iam/v2/introspect_some'].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 Chef Automate API Documentation Authorization API
  version: 1.0.0
extends: openapi/progress-software-authorization-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: 3
- target: $.paths['/apis/iam/v2/introspect'].get
  update:
    x-apievangelist-phrasing:
      intent: List all endpoints I'm allowed to call
      effect: read
      questions:
      - Which API endpoints does my current identity have access to?
      - Can I see all my permissions across the API at once?
      instructions:
      - text: List every endpoint I'm authorized for.
      - text: Introspect all my API permissions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/introspect'].post
  update:
    x-apievangelist-phrasing:
      intent: Check my access to one endpoint
      effect: read
      questions:
      - Am I allowed to call a specific API path?
      - Which HTTP methods can I use on a particular endpoint?
      instructions:
      - text: Check my permissions on path {path}.
        slots:
          path: requestBody.path
      - text: Introspect access to {path} with parameters {parameters}.
        slots:
          path: requestBody.path
          parameters: requestBody.parameters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/apis/iam/v2/introspect_some'].post
  update:
    x-apievangelist-phrasing:
      intent: Check my access to several endpoints
      effect: read
      questions:
      - Can I check access to a list of API paths in one call?
      - Which of these endpoints am I permitted to use?
      instructions:
      - text: Check my permissions on paths {paths}.
        slots:
          paths: requestBody.paths
      - text: Introspect access for the endpoints {paths}.
        slots:
          paths: requestBody.paths
      method: generated
      generated: '2026-10-01'