Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Field Set Settings API

4 actions 4 updates phrasing extends openapi/conga-fieldsetsettings-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 4

$.info
$.paths['/field-sets'].get
$.paths['/field-sets/{name}'].get
$.paths['/field-sets/{name}'].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 Administration Field Set Settings API
  version: 1.0.0
extends: openapi/conga-fieldsetsettings-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: 3
- target: $.paths['/field-sets'].get
  update:
    x-apievangelist-phrasing:
      intent: List field sets
      effect: read
      questions:
      - Which field sets are configured in administration?
      - Can I see every field set at once?
      instructions:
      - text: List all field sets.
      - text: Show the configured field sets.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/field-sets/{name}'].get
  update:
    x-apievangelist-phrasing:
      intent: List the fields in a field set
      effect: read
      questions:
      - Which fields belong to a particular field set?
      - What does a named field set contain?
      instructions:
      - text: List the fields in field set {name}.
        slots:
          name: path.name
      - text: Show what fields field set {name} includes.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/field-sets/{name}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update the fields in a field set
      effect: write
      questions:
      - How do I change which fields a field set includes?
      - Can I reorder or replace fields in a field set?
      instructions:
      - text: Update the fields in field set {name}.
        slots:
          name: path.name
      - text: Replace the field list of field set {name}.
        slots:
          name: path.name
      method: generated
      generated: '2026-10-01'