Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contracts Contract Team Members API

7 actions 7 updates phrasing extends openapi/conga-contract-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/contracts/{contractId}/teammembers'].post
$.paths['/api/clm/v1/contracts/{contractId}/teammembers/by-action/{actionName}'].get
$.paths['/api/clm/v1/contracts/{contractId}/teammembers/query'].post
$.paths['/api/clm/v1/contracts/{contractId}/teammembers/{teamMemberId}'].get
$.paths['/api/clm/v1/contracts/{contractId}/teammembers/{teamMemberId}'].put
$.paths['/api/clm/v1/contracts/{contractId}/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 Team Members API
  version: 1.0.0
extends: openapi/conga-contract-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/contracts/{contractId}/teammembers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add team members to a contract
      effect: write
      questions:
      - How do I add people to a contract's team with a team role?
      - Can I add several team members to a contract at once?
      instructions:
      - text: Add these team members to contract {contract}.
        slots:
          contract: path.contractId
      - text: Put new people on the team for contract {contract}.
        slots:
          contract: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/teammembers/by-action/{actionName}'].get
  update:
    x-apievangelist-phrasing:
      intent: List contract team members for an action
      effect: read
      questions:
      - Which team members on a contract are tied to a specific action?
      - Who on the contract team can perform a given contract action?
      instructions:
      - text: List contract {contract} team members for action {action}.
        slots:
          contract: path.contractId
          action: path.actionName
      - text: Show who handles action {action} on contract {contract}.
        slots:
          action: path.actionName
          contract: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/teammembers/query'].post
  update:
    x-apievangelist-phrasing:
      intent: List all team members of a contract
      effect: read
      questions:
      - Who is on the team for a contract?
      - Can I search a contract's team members by name?
      instructions:
      - text: List the team members of contract {contract}.
        slots:
          contract: path.contractId
      - text: Search contract {contract} team for {term}.
        slots:
          contract: path.contractId
          term: requestBody.SearchText
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/teammembers/{teamMemberId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contract team member
      effect: read
      questions:
      - What role does a specific team member have on a contract?
      - How do I see one contract team member's details?
      instructions:
      - text: Get team member {member} on contract {contract}.
        slots:
          member: path.teamMemberId
          contract: path.contractId
      - text: Show the role of contract {contract} team member {member}.
        slots:
          contract: path.contractId
          member: path.teamMemberId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/teammembers/{teamMemberId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a contract team member
      effect: write
      questions:
      - How do I change a team member's role on a contract?
      - Can I switch which user fills a contract team slot?
      instructions:
      - text: Update team member {member} on contract {contract}.
        slots:
          member: path.teamMemberId
          contract: path.contractId
      - text: Set the team role of member {member} on contract {contract} to {role}.
        slots:
          member: path.teamMemberId
          contract: path.contractId
          role: requestBody.TeamRole
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/teammembers/{teamMemberId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a team member from a contract
      effect: destructive
      questions:
      - How do I take someone off a contract's team?
      - Can I remove a single team member from a contract?
      instructions:
      - text: Remove team member {member} from contract {contract}.
        slots:
          member: path.teamMemberId
          contract: path.contractId
      - text: Take {member} off the team for contract {contract}.
        slots:
          member: path.teamMemberId
          contract: path.contractId
      method: generated
      generated: '2026-10-01'