Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for X-Author Agreement Lock API

4 actions 4 updates phrasing extends openapi/conga-agreementlock-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 4

$.info

$.paths['/api/xauthor/v1/contracts/{contractId}/documents/lock-status'].post

$.paths['/api/xauthor/v1/contracts/{contractId}/documents/release-lock'].post

$.paths['/api/xauthor/v1/contracts/{contractId}/documents/{documentid}/acquire-lock'].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 X-Author Agreement Lock API
  version: 1.0.0
extends: openapi/conga-agreementlock-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: 3
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/documents/lock-status'].post
  update:
    x-apievangelist-phrasing:
      intent: Check whether an agreement document is locked
      effect: read
      questions:
      - Is someone else currently editing this agreement document?
      - How can I tell if an agreement is locked before I check it out?
      instructions:
      - text: Check the lock status of agreement {contractId}.
        slots:
          contractId: path.contractId
      - text: Tell me who holds the edit lock on agreement {contractId}.
        slots:
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/documents/release-lock'].post
  update:
    x-apievangelist-phrasing:
      intent: Release the edit lock on an agreement
      effect: write
      questions:
      - How do I unlock an agreement so others can edit it?
      - Can I release my lock on an agreement document when I'm done?
      instructions:
      - text: Release the lock on agreement {contractId}.
        slots:
          contractId: path.contractId
      - text: Unlock agreement {contractId} so someone else can check it out.
        slots:
          contractId: path.contractId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/contracts/{contractId}/documents/{documentid}/acquire-lock'].post
  update:
    x-apievangelist-phrasing:
      intent: Lock an agreement document for editing
      effect: write
      questions:
      - How do I lock an agreement document so nobody else edits it while I work?
      - Can I acquire an edit lock on one specific agreement document?
      instructions:
      - text: Lock document {documentid} on agreement {contractId} for my editing.
        slots:
          documentid: path.documentid
          contractId: path.contractId
      - text: Acquire the edit lock for agreement {contractId}, document {documentid}.
        slots:
          contractId: path.contractId
          documentid: path.documentid
      method: generated
      generated: '2026-10-01'