Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Sign Roles Verification API

6 actions 6 updates phrasing extends openapi/conga-rolesverification-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 6

$.info

$.paths['/v1/cs-account/{accountId}/verificationTypes'].get

$.paths['/v1/cs-packages/{packageId}/roles/{roleId}/verification'].get

$.paths['/v1/cs-packages/{packageId}/roles/{roleId}/verification'].put

$.paths['/v1/cs-packages/{packageId}/roles/{roleId}/verification'].post

$.paths['/v1/cs-packages/{packageId}/roles/{roleId}/verification'].delete

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 Conga Sign Roles Verification API
  version: 1.0.0
extends: openapi/conga-rolesverification-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: 5
- target: $.paths['/v1/cs-account/{accountId}/verificationTypes'].get
  update:
    x-apievangelist-phrasing:
      intent: List the account's verification types
      effect: read
      questions:
      - Which advanced identity verification methods are available in my account?
      - What verification types can I assign to a signer role?
      instructions:
      - text: List the verification types available in account {accountId}.
        slots:
          accountId: path.accountId
      - text: Show the advanced verification options for account {accountId}.
        slots:
          accountId: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/roles/{roleId}/verification'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a role's verification method
      effect: read
      questions:
      - What verification method is set for a signer role in a package?
      - Is an external verification method being used for this recipient?
      instructions:
      - text: Get the verification method for role {roleId} in package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      - text: Show how role {roleId} on package {packageId} is verified.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/roles/{roleId}/verification'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a role's verification method
      effect: write
      questions:
      - Can I switch the verification type already set on a signer role?
      - How do I change the settings of a role's existing advanced verification?
      instructions:
      - text: Change role {roleId}'s verification in package {packageId} to type {typeId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
          typeId: requestBody.typeId
      - text: Update the existing verification payload for role {roleId} on package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/roles/{roleId}/verification'].post
  update:
    x-apievangelist-phrasing:
      intent: Add advanced verification to a role
      effect: write
      questions:
      - How do I require an external identity check before a signer can sign?
      - Can I add advanced verification to a role that has none yet?
      instructions:
      - text: Add verification type {typeId} to role {roleId} in package {packageId}.
        slots:
          typeId: requestBody.typeId
          roleId: path.roleId
          packageId: path.packageId
      - text: Set up new advanced verification for role {roleId} on package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-packages/{packageId}/roles/{roleId}/verification'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a role's advanced verification
      effect: destructive
      questions:
      - Can I drop the extra identity verification from a signer role?
      - What happens when I delete a role's external verification method?
      instructions:
      - text: Delete the verification method on role {roleId} in package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      - text: Remove advanced verification from role {roleId} on package {packageId}.
        slots:
          roleId: path.roleId
          packageId: path.packageId
      method: generated
      generated: '2026-10-01'