Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Reviewer API

5 actions 5 updates phrasing extends openapi/conga-reviewer-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 5

$.info

$.paths['/api/review/v1/{reviewtype}/{reviewid}/reviewers'].get

$.paths['/api/review/v1/{reviewtype}/{reviewid}/reviewers'].post

$.paths['/api/review/v1/{reviewtype}/{reviewid}/reviewers/{reviewerid}'].delete

$.paths['/api/review/v1/{reviewtype}/{reviewid}/reviewers/{reviewerid}/end'].post

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 Reviewer API
  version: 1.0.0
extends: openapi/conga-reviewer-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: 4
- target: $.paths['/api/review/v1/{reviewtype}/{reviewid}/reviewers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get reviewers' status on a review
      effect: read
      questions:
      - Who are the reviewers on a review request and where are they up to?
      - Can I see each reviewer's status for a document review?
      instructions:
      - text: List the reviewers on {reviewtype} review {reviewid}.
        slots:
          reviewtype: path.reviewtype
          reviewid: path.reviewid
      - text: Show reviewer status for review {reviewid} of type {reviewtype}.
        slots:
          reviewid: path.reviewid
          reviewtype: path.reviewtype
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/review/v1/{reviewtype}/{reviewid}/reviewers'].post
  update:
    x-apievangelist-phrasing:
      intent: Add reviewers to a started review
      effect: write
      questions:
      - How do I add more reviewers to a review that's already in progress?
      - Can I choose the email template sent to newly added reviewers?
      instructions:
      - text: Add reviewers {Reviewers} to {reviewtype} review {reviewid}.
        slots:
          Reviewers: requestBody.Reviewers
          reviewtype: path.reviewtype
          reviewid: path.reviewid
      - text: Add reviewers to review {reviewid} ({reviewtype}) using email template {EmailTemplateId}.
        slots:
          reviewid: path.reviewid
          reviewtype: path.reviewtype
          EmailTemplateId: requestBody.EmailTemplateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/review/v1/{reviewtype}/{reviewid}/reviewers/{reviewerid}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Cancel a reviewer
      effect: destructive
      questions:
      - How do I cancel one reviewer and revoke their access to the document?
      - Can I notify a reviewer by email when I cancel them?
      instructions:
      - text: Cancel reviewer {reviewerid} on {reviewtype} review {reviewid}.
        slots:
          reviewerid: path.reviewerid
          reviewtype: path.reviewtype
          reviewid: path.reviewid
      - text: Cancel reviewer {reviewerid} from review {reviewid} ({reviewtype}), notifying them with email template {emailTemplateId}.
        slots:
          reviewerid: path.reviewerid
          reviewid: path.reviewid
          reviewtype: path.reviewtype
          emailTemplateId: query.emailTemplateId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/review/v1/{reviewtype}/{reviewid}/reviewers/{reviewerid}/end'].post
  update:
    x-apievangelist-phrasing:
      intent: End one reviewer's review
      effect: destructive
      questions:
      - Can I end the review for just one reviewer while others keep going?
      - What happens to a reviewer's permission when their review is ended?
      instructions:
      - text: End reviewer {reviewerid}'s review on {reviewtype} review {reviewid}.
        slots:
          reviewerid: path.reviewerid
          reviewtype: path.reviewtype
          reviewid: path.reviewid
      - text: Close out reviewer {reviewerid} on review {reviewid} ({reviewtype}).
        slots:
          reviewerid: path.reviewerid
          reviewid: path.reviewid
          reviewtype: path.reviewtype
      method: generated
      generated: '2026-10-01'