Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Product Option Groups API

10 actions 10 updates phrasing extends openapi/conga-productoptiongroups-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 10

$.info
$.paths['/products/{ParentId}/option-groups'].get
$.paths['/products/{ParentId}/option-groups'].post
$.paths['/products/{ParentId}/option-groups'].delete
$.paths['/products/{ParentId}/option-groups'].patch
$.paths['/products/{ParentId}/option-groups/{Id}'].get
$.paths['/products/{ParentId}/option-groups/{Id}'].delete
$.paths['/products/{ParentId}/option-groups/{Id}'].patch
$.paths['/products/{ParentId}/option-groups/{Id}/bulk'].post
$.paths['/products/{ParentId}/option-groups/{Id}/components'].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 Administration Product Option Groups API
  version: 1.0.0
extends: openapi/conga-productoptiongroups-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: 9
- target: $.paths['/products/{ParentId}/option-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List a product's option groups
      effect: read
      questions:
      - How do I see the option groups configured on a bundle product?
      - Can I filter or sort a product's option groups?
      - Which option groups does a Conga CPQ product have?
      instructions:
      - text: List the option groups on product {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: List option groups of product {ParentId} sorted by {sort}.
        slots:
          ParentId: path.ParentId
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{ParentId}/option-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create option groups on a product
      effect: write
      questions:
      - How do I create new option groups for a product?
      - Can I add several option groups to a bundle in one request?
      instructions:
      - text: Create these option groups on product {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Add new option groups to bundle {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{ParentId}/option-groups'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a product's option groups in bulk
      effect: destructive
      questions:
      - Is there a way to remove several option groups from a product at once?
      - Can I bulk delete option groups on a bundle?
      instructions:
      - text: Delete these option groups from product {ParentId} in bulk.
        slots:
          ParentId: path.ParentId
      - text: Remove several option groups from bundle {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{ParentId}/option-groups'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a product's option groups in bulk
      effect: write
      questions:
      - How do I edit many option groups on a product in one go?
      - Can I bulk update the option groups of a bundle?
      instructions:
      - text: Update several option groups on product {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Bulk edit the option groups of bundle {ParentId} with these changes.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{ParentId}/option-groups/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product option group
      effect: read
      questions:
      - How do I look up one option group on a product by its ID?
      - What settings does a single product option group have?
      instructions:
      - text: Get option group {Id} on product {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Show the details of option group {Id} for bundle {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{ParentId}/option-groups/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a product option group
      effect: destructive
      questions:
      - How do I delete just one option group from a product?
      - Can I remove a single option group by its ID?
      instructions:
      - text: Delete option group {Id} from product {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Remove the single option group {Id} on bundle {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{ParentId}/option-groups/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a product option group
      effect: write
      questions:
      - What's the call to change one option group on a product?
      - Can I edit a single option group without touching the others?
      instructions:
      - text: Update option group {Id} on product {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit the single option group {Id} for bundle {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{ParentId}/option-groups/{Id}/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Nest existing option groups as sub option groups
      effect: write
      questions:
      - How do I add existing option groups as sub option groups in a bundle?
      - Can I nest several existing option groups under another option group at once?
      instructions:
      - text: Add these existing option groups as sub option groups of {Id} in bundle {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Nest several existing option groups under option group {Id} on product {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/products/{ParentId}/option-groups/{Id}/components'].get
  update:
    x-apievangelist-phrasing:
      intent: List the option components in an option group
      effect: read
      questions:
      - Which product option components sit inside an option group?
      - Can I see an option group's components priced against a specific price list?
      instructions:
      - text: List the option components in option group {Id} of product {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Fetch components of option group {Id} on product {ParentId} using price list {priceListId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
          priceListId: header.priceListId
      method: generated
      generated: '2026-10-01'