Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for User Management Permission Groups API

5 actions 5 updates phrasing extends openapi/conga-permission-groups-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/api/user-management/v1/permissiongroups'].get
$.paths['/api/user-management/v1/permissiongroups'].post
$.paths['/api/user-management/v1/permissiongroups'].delete
$.paths['/api/user-management/v1/permissiongroups/{permissionGroupName}/clone'].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 User Management Permission Groups API
  version: 1.0.0
extends: openapi/conga-permission-groups-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: 4
- target: $.paths['/api/user-management/v1/permissiongroups'].get
  update:
    x-apievangelist-phrasing:
      intent: List permission groups
      effect: read
      questions:
      - Which permission groups exist?
      - What is the master list of permission groups?
      instructions:
      - text: List all permission groups.
      - text: Show the master permission group list.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/permissiongroups'].post
  update:
    x-apievangelist-phrasing:
      intent: Add permission groups
      effect: write
      questions:
      - How do I create new permission groups?
      - Can I add several group names at once?
      instructions:
      - text: Add permission groups {names}.
        slots:
          names: requestBody.PermissionGroupNamesList
      - text: Create the permission groups {names}.
        slots:
          names: requestBody.PermissionGroupNamesList
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/permissiongroups'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete permission groups
      effect: destructive
      questions:
      - Can I delete permission groups?
      - What happens to users when a permission group is deleted?
      instructions:
      - text: Delete permission groups {names}.
        slots:
          names: requestBody.PermissionGroupNamesList
      - text: Remove the groups {names} from the master list.
        slots:
          names: requestBody.PermissionGroupNamesList
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/permissiongroups/{permissionGroupName}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a permission group
      effect: write
      questions:
      - Can I copy an existing permission group's access?
      - How do I create a group based on another?
      instructions:
      - text: Clone permission group {source} as {name}.
        slots:
          source: requestBody.PermissionGroupNameToClone
          name: path.permissionGroupName
      - text: Create group {name} as a copy of {source}.
        slots:
          name: path.permissionGroupName
          source: requestBody.PermissionGroupNameToClone
      method: generated
      generated: '2026-10-01'