Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for User Management User Group Member API

7 actions 7 updates phrasing extends openapi/conga-user-group-member-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 7

$.info

$.paths['/api/user-management/v1/user-groups/bulk-create-userGroupMembers'].post

$.paths['/api/user-management/v1/user-groups/members'].get

$.paths['/api/user-management/v1/user-groups/members/{userGroupMemberId}'].get

$.paths['/api/user-management/v1/user-groups/{userGroupId}/members'].get

$.paths['/api/user-management/v1/user-groups/{userGroupId}/members/{memberId}'].post

$.paths['/api/user-management/v1/user-groups/{userGroupId}/members/{memberId}'].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 User Group Member API
  version: 1.0.0
extends: openapi/conga-user-group-member-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['/api/user-management/v1/user-groups/bulk-create-userGroupMembers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add members to user groups in bulk
      effect: write
      questions:
      - Can I add many members across several user groups in a single request?
      - Is there a bulk way to populate user groups with members?
      instructions:
      - text: Bulk-add these members to their user groups and return the new member IDs.
      - text: Create all of these user group memberships in one batch.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user-groups/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List user group members across all groups
      effect: read
      questions:
      - Which user group memberships exist across every group in my org?
      - Can I filter and sort group memberships with a criteria expression?
      instructions:
      - text: List all user group members matching {criteria}.
        slots:
          criteria: query.criteria
      - text: Show page {pageNumber} of group memberships across all groups, sorted by {sortField}.
        slots:
          pageNumber: query.pageNumber
          sortField: query.sortField
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user-groups/members/{userGroupMemberId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one user group membership
      effect: read
      questions:
      - What are the details of a single group membership record?
      - Can I look up a user group member by its membership ID?
      instructions:
      - text: Show user group member {userGroupMemberId}.
        slots:
          userGroupMemberId: path.userGroupMemberId
      - text: Fetch the membership record {userGroupMemberId}.
        slots:
          userGroupMemberId: path.userGroupMemberId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user-groups/{userGroupId}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List the members of one user group
      effect: read
      questions:
      - Who belongs to a specific user group?
      - How do I see every member of one group?
      instructions:
      - text: List the members of user group {userGroupId}.
        slots:
          userGroupId: path.userGroupId
      - text: Show who is in group {userGroupId}.
        slots:
          userGroupId: path.userGroupId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user-groups/{userGroupId}/members/{memberId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a member to a user group
      effect: write
      questions:
      - Can I add one user to a specific group?
      - Can a group member be something other than a user, such as another group?
      instructions:
      - text: Add member {memberId} to user group {userGroupId}.
        slots:
          memberId: path.memberId
          userGroupId: path.userGroupId
      - text: Put {memberId} into group {userGroupId} as member type {MemberType}.
        slots:
          memberId: path.memberId
          userGroupId: path.userGroupId
          MemberType: requestBody.MemberType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/user-management/v1/user-groups/{userGroupId}/members/{memberId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a member from a user group
      effect: destructive
      questions:
      - How do I take someone out of a user group?
      - Can I remove a single member from one group without touching others?
      instructions:
      - text: Remove member {memberId} from user group {userGroupId}.
        slots:
          memberId: path.memberId
          userGroupId: path.userGroupId
      - text: Drop {memberId} out of group {userGroupId}.
        slots:
          memberId: path.memberId
          userGroupId: path.userGroupId
      method: generated
      generated: '2026-10-01'