Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for User Management Property Permission API

5 actions 5 updates phrasing extends openapi/conga-property-permission-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/property-permissions/{permissionGroupName}/propertyObjects'].get

$.paths['/api/user-management/v1/property-permissions/{permissionGroupName}/{propertyName}'].get

$.paths['/api/user-management/v1/property-permissions/{permissionGroupName}/{propertyName}'].put

$.paths['/api/user-management/v1/property-permissions/{permissionGroupName}/{propertyName}'].delete

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 Management Property Permission API
  version: 1.0.0
extends: openapi/conga-property-permission-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/property-permissions/{permissionGroupName}/propertyObjects'].get
  update:
    x-apievangelist-phrasing:
      intent: List property objects for a permission group
      effect: read
      questions:
      - Which property objects does a permission group have in Conga?
      - How do I see every object a permission group has property permissions on?
      instructions:
      - text: List the property objects for permission group {permissionGroupName}.
        slots:
          permissionGroupName: path.permissionGroupName
      - text: Show which objects permission group {permissionGroupName} has property permissions on.
        slots:
          permissionGroupName: path.permissionGroupName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/property-permissions/{permissionGroupName}/{propertyName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a property permission
      effect: read
      questions:
      - What access does a permission group have to a specific property?
      - Where can I check the permission set on one property for a group?
      instructions:
      - text: Get the permission on property {propertyName} for group {permissionGroupName}.
        slots:
          propertyName: path.propertyName
          permissionGroupName: path.permissionGroupName
      - text: Show what group {permissionGroupName} can do with property {propertyName}.
        slots:
          permissionGroupName: path.permissionGroupName
          propertyName: path.propertyName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/property-permissions/{permissionGroupName}/{propertyName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a property permission
      effect: write
      questions:
      - How do I grant or change a permission group's access to a property?
      - Can I create the property permission if it doesn't exist yet, or overwrite it if it does?
      instructions:
      - text: Set permission {Permission} on property {propertyName} for group {permissionGroupName}.
        slots:
          Permission: requestBody.Permission
          propertyName: path.propertyName
          permissionGroupName: path.permissionGroupName
      - text: Upsert the property permission for {propertyName} in group {permissionGroupName} with object enablement {ObjectEnablement}.
        slots:
          propertyName: path.propertyName
          permissionGroupName: path.permissionGroupName
          ObjectEnablement: requestBody.ObjectEnablement
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/property-permissions/{permissionGroupName}/{propertyName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a property permission
      effect: destructive
      questions:
      - What's the way to revoke a permission group's access to a property?
      - Can I delete the property permission for one property and group?
      instructions:
      - text: Remove the permission on property {propertyName} for group {permissionGroupName}.
        slots:
          propertyName: path.propertyName
          permissionGroupName: path.permissionGroupName
      - text: Delete group {permissionGroupName}'s property permission for {propertyName}.
        slots:
          permissionGroupName: path.permissionGroupName
          propertyName: path.propertyName
      method: generated
      generated: '2026-10-01'