Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contracts Team Role API

7 actions 7 updates phrasing extends openapi/conga-team-role-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/teamroles'].post
$.paths['/api/clm/v1/teamroles'].delete
$.paths['/api/clm/v1/teamroles/query'].post
$.paths['/api/clm/v1/teamroles/{teamRoleId}'].get
$.paths['/api/clm/v1/teamroles/{teamRoleId}'].put
$.paths['/api/clm/v1/teamroles/{teamRoleId}'].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 Team Role API
  version: 1.0.0
extends: openapi/conga-team-role-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/teamroles'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a contract team role
      effect: write
      questions:
      - How do I set up a new team role for people who review or sign contracts in CLM?
      - Can a new team role be mapped to Send for Review and Send for Signature actions?
      instructions:
      - text: Create a team role named {Name}.
        slots:
          Name: requestBody.Name
      - text: Create an active team role {Name} described as {Description} with actions {Action}.
        slots:
          Name: requestBody.Name
          Description: requestBody.Description
          Action: requestBody.Action
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/teamroles'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several team roles at once
      effect: destructive
      questions:
      - Can I permanently remove a batch of team roles by their IDs?
      - Is there a bulk delete for CLM team roles?
      instructions:
      - text: Permanently delete all the team roles in my list of IDs.
      - text: Bulk remove these team role records from CLM.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/teamroles/query'].post
  update:
    x-apievangelist-phrasing:
      intent: Search team roles with criteria
      effect: read
      questions:
      - What team roles exist in CLM, and can I filter them with a criteria expression?
      - Can I query only active team roles and get a total count back?
      instructions:
      - text: Query team roles matching {CriteriaExpression}.
        slots:
          CriteriaExpression: requestBody.CriteriaExpression
      - text: Fetch {Limit} team roles, skipping {Skip}, returning only {Fields}.
        slots:
          Limit: requestBody.Limit
          Skip: requestBody.Skip
          Fields: requestBody.Fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/teamroles/{teamRoleId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a team role
      effect: read
      questions:
      - How can I view the details and actions of a specific team role?
      - Can I check whether one team role is seeded or user-created?
      instructions:
      - text: Get team role {teamRoleId}.
        slots:
          teamRoleId: path.teamRoleId
      - text: Show the actions mapped to team role {teamRoleId}.
        slots:
          teamRoleId: path.teamRoleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/teamroles/{teamRoleId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a team role
      effect: write
      questions:
      - Can I rename an existing team role or change its description?
      - Is it possible to deactivate a team role instead of deleting it?
      instructions:
      - text: Rename team role {teamRoleId} to {Name}.
        slots:
          teamRoleId: path.teamRoleId
          Name: requestBody.Name
      - text: Set team role {teamRoleId} active status to {IsActive}.
        slots:
          teamRoleId: path.teamRoleId
          IsActive: requestBody.IsActive
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/teamroles/{teamRoleId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one team role
      effect: destructive
      questions:
      - Can I permanently delete a single team role?
      - What happens to a team role record when I remove it by its ID?
      instructions:
      - text: Delete team role {teamRoleId}.
        slots:
          teamRoleId: path.teamRoleId
      - text: Permanently remove the team role with ID {teamRoleId}.
        slots:
          teamRoleId: path.teamRoleId
      method: generated
      generated: '2026-10-01'