Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Review API

15 actions 15 updates phrasing extends openapi/conga-review-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 15

$.info
$.paths['/api/clm/v1/contracts/{contractId}/reviews'].get
$.paths['/api/clm/v1/contracts/{contractId}/reviews'].post
$.paths['/api/clm/v1/contracts/{contractId}/reviews/{reviewId}/cancel'].post
$.paths['/api/clm/v1/contracts/{contractId}/reviews/{reviewId}/end'].post
$.paths['/api/clm/v1/contracts/{contractId}/reviews/{reviewId}/reviewers'].post
$.paths['/api/clm/v1/contracts/{contractId}/reviews/{reviewId}/reviewers/cancel'].post
$.paths['/api/clm/v1/contracts/{contractId}/reviews/{reviewId}/reviewers/end'].post
$.paths['/api/clm/v1/contracts/{contractId}/reviews/{reviewType}/{searchString}'].get
$.paths['/api/clm/v1/reviews/token'].post
$.paths['/api/review/v1/{objecttype}/{objectid}/reviews'].get
$.paths['/api/review/v1/{reviewtype}/start'].post
$.paths['/api/review/v1/{reviewtype}/{reviewid}'].get
$.paths['/api/review/v1/{reviewtype}/{reviewid}'].delete
$.paths['/api/review/v1/{reviewtype}/{reviewid}/end'].post

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 Conga Review API
  version: 1.0.0
extends: openapi/conga-review-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: 14
- target: $.paths['/api/clm/v1/contracts/{contractId}/reviews'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a contract's active review cycle
      effect: read
      questions:
      - Is there a review cycle running on this CLM contract, and who's reviewing it?
      - What status and documents does a contract's active review have?
      instructions:
      - text: Show the active review cycle for contract {contractId}.
        slots:
          contractId: path.contractId
      - text: Get review status and reviewers on CLM contract {contractId}.
        slots:
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/reviews'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a CLM contract out for review
      effect: write
      questions:
      - How do I start a Simple Review or Microsoft 365 Review on a contract?
      - Can I attach supporting documents when sending a contract for review?
      instructions:
      - text: Start a {ReviewType} review of contract {contractId} for documents {PrimaryDocumentIds}, emailing {To}.
        slots:
          ReviewType: requestBody.ReviewType
          contractId: path.contractId
          PrimaryDocumentIds: requestBody.PrimaryDocumentIds
          To: requestBody.To
      - text: Send contract {contractId} for review to {To} with subject {EmailSubject} and message {EmailBody}.
        slots:
          contractId: path.contractId
          To: requestBody.To
          EmailSubject: requestBody.EmailSubject
          EmailBody: requestBody.EmailBody
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/reviews/{reviewId}/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a contract's Microsoft 365 review
      effect: destructive
      questions:
      - What happens to the contract status when I cancel a Microsoft 365 review?
      - Can I call off a CLM contract review that's underway?
      instructions:
      - text: Cancel review {reviewId} on contract {contractId}.
        slots:
          reviewId: path.reviewId
          contractId: path.contractId
      - text: Call off the Microsoft 365 review {reviewId} for CLM contract {contractId}.
        slots:
          reviewId: path.reviewId
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/reviews/{reviewId}/end'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete a contract review
      effect: write
      questions:
      - How do I finish a contract review so it's ready for signature?
      - Can I end a CLM review without sending email notifications?
      instructions:
      - text: End review {reviewId} on contract {contractId} and mark it complete.
        slots:
          reviewId: path.reviewId
          contractId: path.contractId
      - text: 'Complete CLM review {reviewId} for contract {contractId} with email delivery disabled: {disableEmailDelivery}.'
        slots:
          reviewId: path.reviewId
          contractId: path.contractId
          disableEmailDelivery: query.disableEmailDelivery
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/reviews/{reviewId}/reviewers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add reviewers to a contract review cycle
      effect: write
      questions:
      - Can I bring more people into a contract review that's already active?
      - Which details do I need to add reviewers to a CLM review cycle?
      instructions:
      - text: Add reviewers {Reviewers} to review {reviewId} on contract {contractId}.
        slots:
          Reviewers: requestBody.Reviewers
          reviewId: path.reviewId
          contractId: path.contractId
      - text: Invite more reviewers to CLM contract {contractId}'s review {reviewId}.
        slots:
          contractId: path.contractId
          reviewId: path.reviewId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/reviews/{reviewId}/reviewers/cancel'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove reviewers from a contract review
      effect: destructive
      questions:
      - How do I take someone off an active contract review?
      - Does removing a reviewer revoke their Microsoft 365 document access?
      instructions:
      - text: Remove reviewers {ReviewerIds} from review {reviewId} on contract {contractId}.
        slots:
          ReviewerIds: requestBody.ReviewerIds
          reviewId: path.reviewId
          contractId: path.contractId
      - text: Revoke reviewer access for {ReviewerIds} in CLM contract {contractId}'s review {reviewId}.
        slots:
          ReviewerIds: requestBody.ReviewerIds
          contractId: path.contractId
          reviewId: path.reviewId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/reviews/{reviewId}/reviewers/end'].post
  update:
    x-apievangelist-phrasing:
      intent: End the review for specific contract reviewers
      effect: write
      questions:
      - Can I end the review for some reviewers on a contract while it stays open for others?
      - Are reviewers emailed when their part of a contract review ends?
      instructions:
      - text: End the review for reviewers {ReviewerIds} on review {reviewId} of contract {contractId}.
        slots:
          ReviewerIds: requestBody.ReviewerIds
          reviewId: path.reviewId
          contractId: path.contractId
      - text: Finish reviewing for {ReviewerIds} in CLM contract {contractId}'s review {reviewId}.
        slots:
          ReviewerIds: requestBody.ReviewerIds
          contractId: path.contractId
          reviewId: path.reviewId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/contracts/{contractId}/reviews/{reviewType}/{searchString}'].get
  update:
    x-apievangelist-phrasing:
      intent: Find users to add as contract reviewers
      effect: read
      questions:
      - Who can I add as a reviewer on a contract, searching by name or email?
      - Can I look up users by email before starting a contract review?
      instructions:
      - text: Search users matching {searchString} for a {reviewType} review of contract {contractId}.
        slots:
          searchString: path.searchString
          reviewType: path.reviewType
          contractId: path.contractId
      - text: Find possible reviewers named {searchString} for contract {contractId} ({reviewType}).
        slots:
          searchString: path.searchString
          contractId: path.contractId
          reviewType: path.reviewType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/reviews/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an Active Directory token for M365 review
      effect: read
      questions:
      - How can I test my Microsoft 365 SharePoint setup for contract reviews?
      - What do I need to get an Active Directory access token for Microsoft 365 Review?
      instructions:
      - text: Get an Active Directory token for client {ClientId} with scope {Scope}.
        slots:
          ClientId: requestBody.ClientId
          Scope: requestBody.Scope
      - text: Fetch a Microsoft 365 Review access token from login URL {LoginUrl}.
        slots:
          LoginUrl: requestBody.LoginUrl
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/review/v1/{objecttype}/{objectid}/reviews'].get
  update:
    x-apievangelist-phrasing:
      intent: List reviews on a record
      effect: read
      questions:
      - Which reviews have been run on a given record?
      - Can I see all reviews attached to one parent object?
      instructions:
      - text: List reviews for {objecttype} {objectid}.
        slots:
          objecttype: path.objecttype
          objectid: path.objectid
      - text: Show every review on {objecttype} record {objectid}.
        slots:
          objecttype: path.objecttype
          objectid: path.objectid
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/review/v1/{reviewtype}/start'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a document to approvers for review
      effect: write
      questions:
      - Can I send a document to selected approvers using the generic review service?
      - Which notification settings can I set when starting a review?
      instructions:
      - text: Start a {reviewtype} review with reviewers {Reviewers}.
        slots:
          reviewtype: path.reviewtype
          Reviewers: requestBody.Reviewers
      - text: Send document {DocumentDetails} for {reviewtype} review.
        slots:
          DocumentDetails: requestBody.DocumentDetails
          reviewtype: path.reviewtype
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/review/v1/{reviewtype}/{reviewid}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a review's status
      effect: read
      questions:
      - What's the status of a review I started?
      - Can I see the properties of a specific review by ID?
      instructions:
      - text: Get details of {reviewtype} review {reviewid}.
        slots:
          reviewtype: path.reviewtype
          reviewid: path.reviewid
      - text: Show the status of review {reviewid} ({reviewtype}).
        slots:
          reviewid: path.reviewid
          reviewtype: path.reviewtype
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/review/v1/{reviewtype}/{reviewid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a review I started
      effect: destructive
      questions:
      - How do I cancel a review process I kicked off?
      - Can I send an email template when cancelling a review?
      instructions:
      - text: Cancel {reviewtype} review {reviewid}.
        slots:
          reviewtype: path.reviewtype
          reviewid: path.reviewid
      - text: Cancel review {reviewid} ({reviewtype}) and notify with email template {emailTemplateId}.
        slots:
          reviewid: path.reviewid
          reviewtype: path.reviewtype
          emailTemplateId: query.emailTemplateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/review/v1/{reviewtype}/{reviewid}/end'].post
  update:
    x-apievangelist-phrasing:
      intent: End a review I started
      effect: write
      questions:
      - How do I end the whole review process I started?
      - Can I attach a final file when ending my review?
      instructions:
      - text: End my {reviewtype} review {reviewid}.
        slots:
          reviewtype: path.reviewtype
          reviewid: path.reviewid
      - text: Wrap up review {reviewid} ({reviewtype}) using email template {emailTemplateId}.
        slots:
          reviewid: path.reviewid
          reviewtype: path.reviewtype
          emailTemplateId: query.emailTemplateId
      method: generated
      generated: '2026-10-01'