OutSystems · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for User and Access Management Application Roles API

3 actions 3 updates phrasing extends openapi/outsystems-application-roles-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['/application-roles'].get
$.paths['/application-roles/{key}/users'].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 User and Access Management Application Roles API
  version: 1.0.0
extends: openapi/outsystems-application-roles-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['/application-roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List application roles
      effect: read
      questions:
      - Which application roles exist across my ODC apps?
      - Can I filter application roles by app, stage or portfolio?
      - How do I find an end-user role whose name contains a certain word?
      instructions:
      - text: List the application roles defined for app {assetKey}.
        slots:
          assetKey: query.assetKey
      - text: Find application roles whose name contains {nameContains} in stage {environmentKey}.
        slots:
          nameContains: query.nameContains
          environmentKey: query.environmentKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/application-roles/{key}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users holding an application role
      effect: read
      questions:
      - Who are the end users assigned a particular application role?
      - Can I see which users with an app role haven't logged in recently?
      instructions:
      - text: List the users who hold application role {key}.
        slots:
          key: path.key
      - text: Find users in application role {key} whose name or email contains {nameOrEmailContains}.
        slots:
          key: path.key
          nameOrEmailContains: query.nameOrEmailContains
      method: generated
      generated: '2026-10-01'