Conga · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Administration Option Groups API
14 actions
14 updates
phrasing
extends
openapi/conga-option-groups-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.
What the actions change
x-apievangelist-phrasing
Targets 14
$.info
$.paths['/option-groups'].get
$.paths['/option-groups'].post
$.paths['/option-groups'].delete
$.paths['/option-groups'].patch
$.paths['/option-groups/{Id}'].get
$.paths['/option-groups/{Id}'].delete
$.paths['/option-groups/{Id}'].patch
$.paths['/option-groups/{Id}/bundles'].get
$.paths['/option-groups/{Id}/clone'].post
$.paths['/option-groups/{Id}/constraint-rules'].get
$.paths['/option-groups/{Id}/parent-option-groups'].get
$.paths['/option-groups/{optionGroup}/add'].post
$.paths['/option-groups/{optionGroup}/bulk'].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 Option Groups API
version: 1.0.0
extends: openapi/conga-option-groups-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: 13
- target: $.paths['/option-groups'].get
update:
x-apievangelist-phrasing:
intent: List option groups
effect: read
questions:
- Which option groups are defined for bundles?
- Can I filter or page through option groups?
instructions:
- text: List all option groups.
- text: List option groups matching {filter}.
slots:
filter: query.filter
method: generated
generated: '2026-10-01'
- target: $.paths['/option-groups'].post
update:
x-apievangelist-phrasing:
intent: Create option groups
effect: write
questions:
- How do I create new option groups?
- Can I add several option groups at once?
instructions:
- text: Create new option groups.
- text: Add a batch of option groups.
method: generated
generated: '2026-10-01'
- target: $.paths['/option-groups'].delete
update:
x-apievangelist-phrasing:
intent: Delete option groups in bulk
effect: destructive
questions:
- Can I delete several option groups at once?
- Can a bulk option group delete also remove the hierarchy?
instructions:
- text: Bulk delete the selected option groups.
- text: Remove many option groups and their hierarchy {hierarchy}.
slots:
hierarchy: query.deleteHierarchy
method: generated
generated: '2026-10-01'
- target: $.paths['/option-groups'].patch
update:
x-apievangelist-phrasing:
intent: Update option groups in bulk
effect: write
questions:
- Can I edit multiple option groups in one request?
- How do I bulk-update option groups?
instructions:
- text: Bulk update the selected option groups.
- text: Edit several option groups at once.
method: generated
generated: '2026-10-01'
- target: $.paths['/option-groups/{Id}'].get
update:
x-apievangelist-phrasing:
intent: Get an option group
effect: read
questions:
- Where can I see one option group's details?
- Can I include related records when fetching an option group?
instructions:
- text: Get option group {id}.
slots:
id: path.Id
- text: Show option group {id} including {includes}.
slots:
id: path.Id
includes: query.includes
method: generated
generated: '2026-10-01'
- target: $.paths['/option-groups/{Id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete an option group
effect: destructive
questions:
- Can I delete a single option group?
- Does deleting one option group remove its child hierarchy?
instructions:
- text: Delete option group {id}.
slots:
id: path.Id
- text: Remove only option group {id} with hierarchy deletion {hierarchy}.
slots:
id: path.Id
hierarchy: query.deleteHierarchy
method: generated
generated: '2026-10-01'
- target: $.paths['/option-groups/{Id}'].patch
update:
x-apievangelist-phrasing:
intent: Update an option group
effect: write
questions:
- How do I edit one option group?
- Can I rename a single option group?
instructions:
- text: Update option group {id}.
slots:
id: path.Id
- text: Edit only the option group {id}.
slots:
id: path.Id
method: generated
generated: '2026-10-01'
- target: $.paths['/option-groups/{Id}/bundles'].get
update:
x-apievangelist-phrasing:
intent: List bundles using an option group
effect: read
questions:
- Which bundle products use a given option group?
- Where is an option group used across bundles?
instructions:
- text: List the bundle products that use option group {id}.
slots:
id: path.Id
- text: Show bundles containing option group {id}.
slots:
id: path.Id
method: generated
generated: '2026-10-01'
- target: $.paths['/option-groups/{Id}/clone'].post
update:
x-apievangelist-phrasing:
intent: Clone an option group
effect: write
questions:
- Can I copy an option group as a starting point?
- How do I duplicate an existing option group?
instructions:
- text: Clone option group {id}.
slots:
id: path.Id
- text: Make a copy of option group {id}.
slots:
id: path.Id
method: generated
generated: '2026-10-01'
- target: $.paths['/option-groups/{Id}/constraint-rules'].get
update:
x-apievangelist-phrasing:
intent: List constraint rules on an option group
effect: read
questions:
- Which constraint rules reference an option group?
- Are there rules that limit an option group?
instructions:
- text: List constraint rules for option group {id}.
slots:
id: path.Id
- text: Show the rules applied to option group {id}.
slots:
id: path.Id
method: generated
generated: '2026-10-01'
- target: $.paths['/option-groups/{Id}/parent-option-groups'].get
update:
x-apievangelist-phrasing:
intent: List parent option groups
effect: read
questions:
- Which option groups contain a given option group?
- What are the parents of a nested option group?
instructions:
- text: List parent option groups of {id}.
slots:
id: path.Id
- text: Show which groups nest option group {id}.
slots:
id: path.Id
method: generated
generated: '2026-10-01'
- target: $.paths['/option-groups/{optionGroup}/add'].post
update:
x-apievangelist-phrasing:
intent: Nest an existing option group
effect: write
questions:
- How do I put one existing option group inside another?
- Can I reuse an option group as a child?
instructions:
- text: Add existing option group {source} under {group}.
slots:
source: requestBody.SourceOptionGroup
group: path.optionGroup
- text: Nest option group {source} inside {group}.
slots:
source: requestBody.SourceOptionGroup
group: path.optionGroup
method: generated
generated: '2026-10-01'
- target: $.paths['/option-groups/{optionGroup}/bulk'].post
update:
x-apievangelist-phrasing:
intent: Nest several existing option groups
effect: write
questions:
- Can I add several existing option groups under another at once?
- How do I bulk-nest option groups?
instructions:
- text: Add option groups {sources} under {group}.
slots:
sources: requestBody.SourceOptionGroups
group: path.optionGroup
- text: Nest these groups {sources} inside option group {group}.
slots:
sources: requestBody.SourceOptionGroups
group: path.optionGroup
method: generated
generated: '2026-10-01'