Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Sign Authentication Tokens API

5 actions 5 updates phrasing extends openapi/conga-authenticationtokens-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['/v1/cs-authenticationTokens/sender'].post
$.paths['/v1/cs-authenticationTokens/signer/multiUse'].post
$.paths['/v1/cs-authenticationTokens/signer/singleUse'].post
$.paths['/v1/cs-authenticationTokens/user'].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 Sign Authentication Tokens API
  version: 1.0.0
extends: openapi/conga-authenticationtokens-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['/v1/cs-authenticationTokens/sender'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sender token to edit a package
      effect: write
      questions:
      - How can a package owner get a session to edit it in the Designer view?
      - Can I generate a token that lets a sender open their package and send it?
      instructions:
      - text: Create a sender authentication token for package {packageId}.
        slots:
          packageId: requestBody.packageId
      - text: Generate a Designer session token so the owner can edit package {packageId}.
        slots:
          packageId: requestBody.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-authenticationTokens/signer/multiUse'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a reusable signer session token
      effect: write
      questions:
      - Can I create a signer token that works more than once?
      - What's the difference in lifetime for a multi-use signer token?
      instructions:
      - text: Create a multi-use signing token for signer {signerId} on package {packageId}.
        slots:
          signerId: requestBody.signerId
          packageId: requestBody.packageId
      - text: Give signer {signerId} a reusable session token for package {packageId}.
        slots:
          signerId: requestBody.signerId
          packageId: requestBody.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-authenticationTokens/signer/singleUse'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a one-time signer session token
      effect: write
      questions:
      - How do I embed signing by giving a signer a one-time session token?
      - How long does a single-use signer token last?
      instructions:
      - text: Create a single-use signing token for signer {signerId} on package {packageId}.
        slots:
          signerId: requestBody.signerId
          packageId: requestBody.packageId
      - text: Issue a one-time token so signer {signerId} can sign package {packageId}.
        slots:
          signerId: requestBody.signerId
          packageId: requestBody.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-authenticationTokens/user'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a user token to view package details
      effect: write
      questions:
      - Can I get an access token tied to a signer's email to view package details?
      - Is there a user-level token that expires after 30 minutes?
      instructions:
      - text: Create a user access token for {email}.
        slots:
          email: requestBody.email
      - text: Generate a 30-minute package-details token for the signer at {email}.
        slots:
          email: requestBody.email
      method: generated
      generated: '2026-10-01'