Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Document Protection API

5 actions 5 updates phrasing extends openapi/conga-documentprotection-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/xauthor/v1/documents/protect'].post

$.paths['/api/xauthor/v1/documents/unprotect'].post

$.paths['/api/xauthor/v1/documents/{currentprotection}/protections'].get

$.paths['/api/xauthor/v1/documents/{saveoption}/protection'].get

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 X-Author Document Protection API
  version: 1.0.0
extends: openapi/conga-documentprotection-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/xauthor/v1/documents/protect'].post
  update:
    x-apievangelist-phrasing:
      intent: Protect an agreement document
      effect: write
      questions:
      - How do I lock an agreement document without sharing a password?
      - Can I apply a protection level to an agreement document in X-Author?
      instructions:
      - text: Protect this agreement document content {documentContent}.
        slots:
          documentContent: requestBody.documentContent
      - text: Add document protection for org type {OrgType}.
        slots:
          OrgType: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/documents/unprotect'].post
  update:
    x-apievangelist-phrasing:
      intent: Unprotect an agreement document
      effect: write
      questions:
      - How do I remove protection from an agreement document so it's fully editable?
      - Can I unlock an agreement document without the password?
      instructions:
      - text: Unprotect agreement document {documentContent}.
        slots:
          documentContent: requestBody.documentContent
      - text: Remove document protection for org type {OrgType}.
        slots:
          OrgType: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/documents/{currentprotection}/protections'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document's protection type
      effect: read
      questions:
      - What protection type maps to a document's current protection?
      - How do I look up the protection type for a given current protection value?
      instructions:
      - text: Get the protection type for current protection {currentprotection}.
        slots:
          currentprotection: path.currentprotection
      - text: Show protection types for {currentprotection} in org type {OrgType}.
        slots:
          currentprotection: path.currentprotection
          OrgType: header.OrgType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/documents/{saveoption}/protection'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a document's protection level by save option
      effect: read
      questions:
      - Which protection level applies when I save a document version a certain way?
      - How do I find the protection level for a save option?
      instructions:
      - text: Get the protection level for save option {saveoption}.
        slots:
          saveoption: path.saveoption
      - text: Show protection level for {saveoption} versions in org type {OrgType}.
        slots:
          saveoption: path.saveoption
          OrgType: header.OrgType
      method: generated
      generated: '2026-10-01'