Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Sign Sub Accounts API

6 actions 6 updates phrasing extends openapi/conga-subaccounts-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/accessibleaccounts'].get
$.paths['/v1/cs-account/subaccountApiKeys'].get
$.paths['/v1/cs-account/subaccounts'].get
$.paths['/v1/cs-account/subaccounts'].post
$.paths['/v1/cs-account/subaccounts/{accountId}'].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 Sub Accounts API
  version: 1.0.0
extends: openapi/conga-subaccounts-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/accessibleaccounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List sub-accounts I can access
      effect: read
      questions:
      - Which sub-accounts am I allowed to access?
      - How do I see the child accounts available to my user?
      instructions:
      - text: List the sub-accounts I have access to.
      - text: Show every accessible account for my user.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/subaccountApiKeys'].get
  update:
    x-apievangelist-phrasing:
      intent: List my API keys across sub-accounts
      effect: read
      questions:
      - How do I get my API keys for each sub-account?
      - What permissions do I need to see sub-account API keys?
      instructions:
      - text: List my API keys for the sub-accounts.
      - text: Show the sub-account API keys for my user.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/subaccounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List child sub-accounts of my account
      effect: read
      questions:
      - What sub-accounts sit under my current account?
      - How do I list the child accounts of this account?
      instructions:
      - text: List the direct sub-accounts of my current account.
      - text: Show child accounts under this account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/subaccounts'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a sub-account
      effect: write
      questions:
      - How do I create a child account for a department or region?
      - Can I set a sub-account's language and timezone when creating it?
      instructions:
      - text: Create a sub-account named {name}.
        slots:
          name: requestBody.name
      - text: Create sub-account {name} under parent {parentAccountId}.
        slots:
          name: requestBody.name
          parentAccountId: requestBody.parentAccountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/subaccounts/{accountId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a sub-account
      effect: write
      questions:
      - How do I rename an existing sub-account?
      - Can I change a sub-account's timezone?
      instructions:
      - text: Rename sub-account {accountId} to {name}.
        slots:
          accountId: path.accountId
          name: requestBody.name
      - text: Set sub-account {accountId}'s timezone to {timezoneId}.
        slots:
          accountId: path.accountId
          timezoneId: requestBody.timezoneId
      method: generated
      generated: '2026-10-01'