Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Conga Configuration API

15 actions 15 updates phrasing extends openapi/conga-configuration-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 15

$.info
$.paths['/api/config-management/v1/configurations'].put
$.paths['/api/config-management/v1/configurations'].post
$.paths['/api/config-management/v1/configurations/categories'].get
$.paths['/api/config-management/v1/configurations/export'].post
$.paths['/api/config-management/v1/configurations/import'].post
$.paths['/api/config-management/v1/configurations/{category}'].get
$.paths['/api/config-management/v1/configurations/{category}'].post
$.paths['/api/config-management/v1/configurations/{category}/{name}'].get
$.paths['/api/config-management/v1/configurations/{category}/{name}'].delete
$.paths['/api/esign/v1/esignatures/configuration'].get
$.paths['/api/esign/v1/esignatures/configuration'].put
$.paths['/api/esign/v1/esignatures/configuration/activate'].post
$.paths['/api/esign/v1/esignatures/configuration/default'].post
$.paths['/v1/Configuration/environment-info'].get

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 Configuration API
  version: 1.0.0
extends: openapi/conga-configuration-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: 14
- target: $.paths['/api/config-management/v1/configurations'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an existing configuration value
      effect: write
      questions:
      - How do I change the value of a configuration setting that already exists?
      - Can I edit a configuration entry inside a specific category?
      instructions:
      - text: Update configuration {Name} in category {Category} to value {Value}.
        slots:
          Name: requestBody.Name
          Category: requestBody.Category
          Value: requestBody.Value
      - text: Change the existing {Name} setting to {Value}.
        slots:
          Name: requestBody.Name
          Value: requestBody.Value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/config-management/v1/configurations'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new configuration
      effect: write
      questions:
      - How do I add a brand-new configuration entry to the platform?
      - Can I group new configurations under a category like CLM or eSign?
      instructions:
      - text: Add a new configuration {Name} with value {Value} under category {Category}.
        slots:
          Name: requestBody.Name
          Value: requestBody.Value
          Category: requestBody.Category
      - text: Create configuration {Name} set to {Value}.
        slots:
          Name: requestBody.Name
          Value: requestBody.Value
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/config-management/v1/configurations/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List configuration categories
      effect: read
      questions:
      - What configuration categories are available?
      - Which categories are my configurations grouped into?
      instructions:
      - text: List all configuration categories.
      - text: Show the categories used to group configurations.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/config-management/v1/configurations/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export custom configuration as a zip
      effect: read
      questions:
      - How can I export my custom configuration to move it to another environment?
      - Can I download configuration for only certain categories as a zip file?
      instructions:
      - text: Export the custom configuration for these categories as a zip.
      - text: Download a zipped export of my custom configuration.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/config-management/v1/configurations/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import custom configuration from a zip
      effect: write
      questions:
      - How do I load a configuration zip exported from another environment?
      - What happens if an imported configuration already exists?
      instructions:
      - text: Import custom configuration from zip file {file}.
        slots:
          file: requestBody.file
      - text: Upload configuration package {file} into this environment.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/config-management/v1/configurations/{category}'].get
  update:
    x-apievangelist-phrasing:
      intent: List all configurations in a category
      effect: read
      questions:
      - Which configurations belong to the eSign category?
      - Can I see every setting in one configuration category?
      instructions:
      - text: List all configurations in category {category}.
        slots:
          category: path.category
      - text: Show every {category} configuration setting.
        slots:
          category: path.category
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/config-management/v1/configurations/{category}'].post
  update:
    x-apievangelist-phrasing:
      intent: Fetch several named configurations at once
      effect: read
      questions:
      - Can I fetch a handful of specific configuration names from a category in one request?
      - How do I look up multiple named settings together?
      instructions:
      - text: Get these named configurations from category {category}.
        slots:
          category: path.category
      - text: Fetch the listed configuration names within {category} in one call.
        slots:
          category: path.category
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/config-management/v1/configurations/{category}/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single configuration
      effect: read
      questions:
      - What is the current value of one specific configuration?
      - Where can I read a single setting by its category and name?
      instructions:
      - text: Get configuration {name} in category {category}.
        slots:
          name: path.name
          category: path.category
      - text: Show the value of the {category} setting {name}.
        slots:
          category: path.category
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/config-management/v1/configurations/{category}/{name}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a configuration
      effect: destructive
      questions:
      - Can I remove a configuration setting I no longer need?
      - Is deleting a configuration by category and name permanent?
      instructions:
      - text: Delete configuration {name} from category {category}.
        slots:
          name: path.name
          category: path.category
      - text: Remove the {category} setting named {name}.
        slots:
          category: path.category
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/esign/v1/esignatures/configuration'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the eSignature provider configuration
      effect: read
      questions:
      - How is my eSignature provider currently configured?
      - Can I view the sign configuration for one particular provider type?
      instructions:
      - text: Show the eSignature configuration.
      - text: Get the sign configuration for provider type {signProviderType}.
        slots:
          signProviderType: query.signProviderType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/esign/v1/esignatures/configuration'].put
  update:
    x-apievangelist-phrasing:
      intent: Save the eSignature provider configuration
      effect: write
      questions:
      - How do I connect and configure an eSignature service for contracts?
      - Will saving the sign configuration give me a consent URL to authorize the provider?
      instructions:
      - text: Save sign configuration {Configuration} for provider type {signProviderType}.
        slots:
          Configuration: requestBody.Configuration
          signProviderType: query.signProviderType
      - text: Update the {signProviderType} eSignature settings with state {State}.
        slots:
          signProviderType: query.signProviderType
          State: requestBody.State
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/esign/v1/esignatures/configuration/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate an eSignature provider
      effect: write
      questions:
      - How do I enable a configured sign provider so it can be used for signatures?
      - Does a sign provider need to be activated before sending documents for signature?
      instructions:
      - text: Activate sign provider {signProviderType}.
        slots:
          signProviderType: query.signProviderType
      - text: Turn on {signProviderType} for eSignature operations.
        slots:
          signProviderType: query.signProviderType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/esign/v1/esignatures/configuration/default'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the default eSignature provider
      effect: write
      questions:
      - Which sign provider should new eSignature transactions use by default?
      - Can I make one sign provider the default for every new signature request?
      instructions:
      - text: Make {signProviderType} the default sign provider.
        slots:
          signProviderType: query.signProviderType
      - text: Use {signProviderType} as the default for all new eSignature transactions.
        slots:
          signProviderType: query.signProviderType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/Configuration/environment-info'].get
  update:
    x-apievangelist-phrasing:
      intent: Get environment and region info
      effect: read
      questions:
      - Which environment and region is this service running in?
      - How do I check the configured region?
      instructions:
      - text: Show environment and region details.
      - text: Get the current environment info.
      method: generated
      generated: '2026-10-01'