# 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 Organization Roles API
  version: 1.0.0
extends: openapi/outsystems-organization-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: 6
- target: $.paths['/organization-roles'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization roles
      effect: read
      questions:
      - What organization roles are defined for ODC members?
      - Can I search organization roles by name?
      instructions:
      - text: List all organization roles.
      - text: Find organization roles whose name contains {nameContains}.
        slots:
          nameContains: query.nameContains
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organization-roles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an organization role
      effect: write
      questions:
      - How do I create a custom organization role with specific permissions?
      - Can I define a new member role for my organization?
      instructions:
      - text: Create organization role {name} with permissions {permissions}.
        slots:
          name: requestBody.name
          permissions: requestBody.permissions
      - text: Add a new organization role called {name}.
        slots:
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organization-roles/{key}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization role
      effect: read
      questions:
      - Which permissions does a particular organization role include?
      - How do I look up one organization role by key?
      instructions:
      - text: Get organization role {key}.
        slots:
          key: path.key
      - text: Show the permissions in organization role {key}.
        slots:
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organization-roles/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an organization role
      effect: destructive
      questions:
      - Can I delete a custom organization role?
      - What permission is needed to remove an organization role?
      instructions:
      - text: Delete organization role {key}.
        slots:
          key: path.key
      - text: Remove the organization role {key} permanently.
        slots:
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organization-roles/{key}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an organization role
      effect: write
      questions:
      - How do I change the permissions granted by an organization role?
      - Can I rename an existing organization role?
      instructions:
      - text: Rename organization role {key} to {name}.
        slots:
          key: path.key
          name: requestBody.name
      - text: Set the permissions of organization role {key} to {permissions}.
        slots:
          key: path.key
          permissions: requestBody.permissions
      method: generated
      generated: '2026-10-01'
- target: $.paths['/organization-roles/{key}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List members holding an organization role
      effect: read
      questions:
      - Who in my organization has a particular organization role?
      - Can I search the holders of an organization role by name or email?
      instructions:
      - text: List the users with organization role {key}.
        slots:
          key: path.key
      - text: Find holders of organization role {key} matching {nameOrEmailContains}.
        slots:
          key: path.key
          nameOrEmailContains: query.nameOrEmailContains
      method: generated
      generated: '2026-10-01'