OutSystems · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for User and Access Management Permissions API

3 actions 3 updates phrasing extends openapi/outsystems-permissions-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for OutSystems's API. It is a proposal applied on top of the contract, not a document OutSystems publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/permissions'].get

$.paths['/permissions/{key}'].get

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 User and Access Management Permissions API
  version: 1.0.0
extends: openapi/outsystems-permissions-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['/permissions'].get
  update:
    x-apievangelist-phrasing:
      intent: List available permissions
      effect: read
      questions:
      - What permissions can be assigned to roles in ODC?
      - Can I search the permission catalog by name?
      instructions:
      - text: List all permissions.
      - text: Find permissions whose name contains {nameContains}.
        slots:
          nameContains: query.nameContains
      method: generated
      generated: '2026-10-01'
- target: $.paths['/permissions/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a permission's details
      effect: read
      questions:
      - What exactly does a particular permission allow?
      - How do I look up one permission by key?
      instructions:
      - text: Get permission {key}.
        slots:
          key: path.key
      - text: Show the details of permission {key}.
        slots:
          key: path.key
      method: generated
      generated: '2026-10-01'