Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Response Field Configuration API

6 actions 6 updates phrasing extends openapi/conga-responsefieldconfiguration-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['/responsefield-configuration/{categoryName}'].get

$.paths['/responsefield-configuration/{categoryName}/{configName}'].get

$.paths['/responsefield-configuration/{categoryName}/{configName}'].put

$.paths['/responsefield-configuration/{categoryName}/{configName}'].delete

$.paths['/responsefield-configuration/{categoryName}/{defaultConfigName}/{newConfigName}'].post

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 Administration Response Field Configuration API
  version: 1.0.0
extends: openapi/conga-responsefieldconfiguration-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['/responsefield-configuration/{categoryName}'].get
  update:
    x-apievangelist-phrasing:
      intent: List response field configurations in a category
      effect: read
      questions:
      - Which response field configurations exist for a category?
      - Can I see the names of all field set configurations under one category?
      instructions:
      - text: List response field configuration names in category {categoryName}.
        slots:
          categoryName: path.categoryName
      - text: Show the field set configurations for {categoryName}.
        slots:
          categoryName: path.categoryName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/responsefield-configuration/{categoryName}/{configName}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a response field configuration
      effect: read
      questions:
      - What fields does a named response field configuration return?
      - Can I fetch one field set configuration by its name?
      instructions:
      - text: Get response field configuration {configName} in category {categoryName}.
        slots:
          configName: path.configName
          categoryName: path.categoryName
      - text: Show field set config {configName} for {categoryName}.
        slots:
          configName: path.configName
          categoryName: path.categoryName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/responsefield-configuration/{categoryName}/{configName}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a response field configuration
      effect: write
      questions:
      - How do I change the fields in an existing response field configuration?
      - Can I edit a field set configuration in place?
      instructions:
      - text: Update response field configuration {configName} in category {categoryName}.
        slots:
          configName: path.configName
          categoryName: path.categoryName
      - text: Change the fields of config {configName} under {categoryName}.
        slots:
          configName: path.configName
          categoryName: path.categoryName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/responsefield-configuration/{categoryName}/{configName}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a response field configuration
      effect: destructive
      questions:
      - How do I remove a response field configuration I no longer need?
      - Can a field set configuration be deleted?
      instructions:
      - text: Delete response field configuration {configName} from category {categoryName}.
        slots:
          configName: path.configName
          categoryName: path.categoryName
      - text: Remove field set config {configName} under {categoryName}.
        slots:
          configName: path.configName
          categoryName: path.categoryName
      method: generated
      generated: '2026-10-01'
- target: $.paths['/responsefield-configuration/{categoryName}/{defaultConfigName}/{newConfigName}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a response field configuration from a default
      effect: write
      questions:
      - How do I create a new response field configuration based on a default one?
      - Can I copy a default field set configuration under a new name?
      instructions:
      - text: Create config {newConfigName} in {categoryName} from default {defaultConfigName}.
        slots:
          newConfigName: path.newConfigName
          categoryName: path.categoryName
          defaultConfigName: path.defaultConfigName
      - text: Add field set config {newConfigName} under {categoryName} based on {defaultConfigName}.
        slots:
          newConfigName: path.newConfigName
          categoryName: path.categoryName
          defaultConfigName: path.defaultConfigName
      method: generated
      generated: '2026-10-01'