Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Sign Data Management API

5 actions 5 updates phrasing extends openapi/conga-data-management-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-dataRetentionSettings/dataManagementPolicy'].get
$.paths['/v1/cs-dataRetentionSettings/dataManagementPolicy'].put
$.paths['/v1/cs-dataRetentionSettings/expiryTimeConfiguration'].get
$.paths['/v1/cs-dataRetentionSettings/expiryTimeConfiguration'].put

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 Data Management API
  version: 1.0.0
extends: openapi/conga-data-management-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-dataRetentionSettings/dataManagementPolicy'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the data management policy
      effect: read
      questions:
      - How long does my account keep transactions before they are removed?
      - What data retention policy is set on the account?
      instructions:
      - text: Show the account's data management policy.
      - text: Get the current transaction retention settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-dataRetentionSettings/dataManagementPolicy'].put
  update:
    x-apievangelist-phrasing:
      intent: Update transaction retention policy
      effect: write
      questions:
      - Can I change how long transactions are retained?
      - Is transaction retention configurable per account?
      instructions:
      - text: Set transaction retention to {transactionRetention}.
        slots:
          transactionRetention: requestBody.transactionRetention
      - text: Update the data management policy with retention {transactionRetention}.
        slots:
          transactionRetention: requestBody.transactionRetention
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-dataRetentionSettings/expiryTimeConfiguration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get transaction expiry settings
      effect: read
      questions:
      - What expiry period is configured for transactions on my account?
      - Does a 0 in the expiry configuration mean unlimited?
      instructions:
      - text: Show the account's expiry time configuration.
      - text: Get the remaining-days expiry settings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-dataRetentionSettings/expiryTimeConfiguration'].put
  update:
    x-apievangelist-phrasing:
      intent: Update transaction expiry settings
      effect: write
      questions:
      - Can I set transactions to never expire?
      - How do I change the default and maximum days before expiry?
      instructions:
      - text: Set the default expiry to {remainingDays} days.
        slots:
          remainingDays: requestBody.remainingDays
      - text: Set default expiry {remainingDays} days and maximum {maximumRemainingDays} days.
        slots:
          remainingDays: requestBody.remainingDays
          maximumRemainingDays: requestBody.maximumRemainingDays
      method: generated
      generated: '2026-10-01'