Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Sign O Auth2 API

6 actions 6 updates phrasing extends openapi/conga-oauth2-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/authentication/oauth2/clients'].get
$.paths['/v1/cs-account/authentication/oauth2/clients'].post
$.paths['/v1/cs-account/authentication/oauth2/clients/{clientId}'].delete
$.paths['/v1/cs-account/authentication/oauth2/clients/{clientId}/regenerate-secret'].post
$.paths['/v1/cs-oauth2/token'].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 O Auth2 API
  version: 1.0.0
extends: openapi/conga-oauth2-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/authentication/oauth2/clients'].get
  update:
    x-apievangelist-phrasing:
      intent: List OAuth2 clients
      effect: read
      questions:
      - Which OAuth2 clients exist on my Conga account?
      - Can I see client aliases and IDs without exposing secrets?
      instructions:
      - text: List my OAuth2 clients.
      - text: Show every OAuth2 client with its alias and creation date.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/authentication/oauth2/clients'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an OAuth2 client
      effect: write
      questions:
      - How do I get a client ID and secret for API access?
      - Can I name a new OAuth2 client with an alias?
      instructions:
      - text: Create an OAuth2 client with alias {alias}.
        slots:
          alias: requestBody.alias
      - text: Register a new API client called {alias}.
        slots:
          alias: requestBody.alias
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/authentication/oauth2/clients/{clientId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an OAuth2 client
      effect: destructive
      questions:
      - Can I permanently revoke an OAuth2 client?
      - What happens to a client's credentials when it is deleted?
      instructions:
      - text: Delete OAuth2 client {clientId}.
        slots:
          clientId: path.clientId
      - text: Permanently remove the API client {clientId}.
        slots:
          clientId: path.clientId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/authentication/oauth2/clients/{clientId}/regenerate-secret'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate an OAuth2 client secret
      effect: destructive
      questions:
      - How do I rotate a client secret that may have leaked?
      - Does regenerating a secret invalidate the old one immediately?
      instructions:
      - text: Regenerate the secret for OAuth2 client {clientId}.
        slots:
          clientId: path.clientId
      - text: Rotate the client secret on {clientId}.
        slots:
          clientId: path.clientId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-oauth2/token'].post
  update:
    x-apievangelist-phrasing:
      intent: Get an access token with client credentials
      effect: write
      questions:
      - How do I exchange my client ID and secret for an access token?
      - Which grant type does the token endpoint support?
      instructions:
      - text: Get an access token for client {client_id} with grant type {grant_type}.
        slots:
          client_id: requestBody.client_id
          grant_type: requestBody.grant_type
      - text: Request a token using grant {grant_type}, client {client_id} and secret {client_secret}.
        slots:
          grant_type: requestBody.grant_type
          client_id: requestBody.client_id
          client_secret: requestBody.client_secret
      method: generated
      generated: '2026-10-01'