Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contracts Contract Request Team Members API

7 actions 7 updates phrasing extends openapi/conga-contract-request-team-members-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/clm/v1/requests/{contractRequestId}/teammembers'].post
$.paths['/api/clm/v1/requests/{contractRequestId}/teammembers/by-action/{actionName}'].get
$.paths['/api/clm/v1/requests/{contractRequestId}/teammembers/query'].post
$.paths['/api/clm/v1/requests/{contractRequestId}/teammembers/{teamMemberId}'].get
$.paths['/api/clm/v1/requests/{contractRequestId}/teammembers/{teamMemberId}'].put
$.paths['/api/clm/v1/requests/{contractRequestId}/teammembers/{teamMemberId}'].delete

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 Contracts Contract Request Team Members API
  version: 1.0.0
extends: openapi/conga-contract-request-team-members-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/clm/v1/requests/{contractRequestId}/teammembers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add team members to a contract request
      effect: write
      questions:
      - How do I add people to a contract request team and give them a role?
      - Can I add several team members to a contract request in one call?
      instructions:
      - text: Add these team members to contract request {contractRequestId}.
        slots:
          contractRequestId: path.contractRequestId
      - text: Assign new team members with roles on a contract request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/requests/{contractRequestId}/teammembers/by-action/{actionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get team members for a contract action
      effect: read
      questions:
      - Which team members on a contract request are tied to a specific action?
      - How do I find who is assigned to a given contract action on a request?
      instructions:
      - text: List team members on request {contractRequestId} for action {actionName}.
        slots:
          contractRequestId: path.contractRequestId
          actionName: path.actionName
      - text: Show who handles the {actionName} action on contract request {contractRequestId}.
        slots:
          actionName: path.actionName
          contractRequestId: path.contractRequestId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/requests/{contractRequestId}/teammembers/query'].post
  update:
    x-apievangelist-phrasing:
      intent: List team members on a contract request
      effect: read
      questions:
      - Who is on the team for a contract request?
      - Can I search a contract request's team members by name?
      instructions:
      - text: List team members on contract request {contractRequestId}.
        slots:
          contractRequestId: path.contractRequestId
      - text: Search team members of request {contractRequestId} for {SearchText}.
        slots:
          contractRequestId: path.contractRequestId
          SearchText: requestBody.SearchText
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/requests/{contractRequestId}/teammembers/{teamMemberId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contract request team member
      effect: read
      questions:
      - How do I see one team member's details and role on a contract request?
      - Can I look up a single contract request team member by ID?
      instructions:
      - text: Show team member {teamMemberId} on contract request {contractRequestId}.
        slots:
          teamMemberId: path.teamMemberId
          contractRequestId: path.contractRequestId
      - text: Get the team role of member {teamMemberId} on request {contractRequestId}.
        slots:
          teamMemberId: path.teamMemberId
          contractRequestId: path.contractRequestId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/requests/{contractRequestId}/teammembers/{teamMemberId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a contract request team member
      effect: write
      questions:
      - How do I change a team member's role on a contract request?
      - Can I swap the person assigned to a team member slot on a request?
      instructions:
      - text: Change team member {teamMemberId} on request {contractRequestId} to role {TeamRole}.
        slots:
          teamMemberId: path.teamMemberId
          contractRequestId: path.contractRequestId
          TeamRole: requestBody.TeamRole
      - text: Update member {teamMemberId} on contract request {contractRequestId} to {TeamMember}.
        slots:
          teamMemberId: path.teamMemberId
          contractRequestId: path.contractRequestId
          TeamMember: requestBody.TeamMember
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/requests/{contractRequestId}/teammembers/{teamMemberId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a team member from a contract request
      effect: destructive
      questions:
      - How do I take someone off a contract request team?
      - Can I remove a single member from a request's team?
      instructions:
      - text: Remove team member {teamMemberId} from contract request {contractRequestId}.
        slots:
          teamMemberId: path.teamMemberId
          contractRequestId: path.contractRequestId
      - text: Drop member {teamMemberId} off the team for request {contractRequestId}.
        slots:
          teamMemberId: path.teamMemberId
          contractRequestId: path.contractRequestId
      method: generated
      generated: '2026-10-01'