Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Product Option Components API

8 actions 8 updates phrasing extends openapi/conga-product-option-components-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 8

$.info
$.paths['/product-option-group/{ParentId}/products'].get
$.paths['/product-option-group/{ParentId}/products'].post
$.paths['/product-option-group/{ParentId}/products'].delete
$.paths['/product-option-group/{ParentId}/products'].patch
$.paths['/product-option-group/{ParentId}/products/{Id}'].get
$.paths['/product-option-group/{ParentId}/products/{Id}'].delete
$.paths['/product-option-group/{ParentId}/products/{Id}'].patch

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 Components API
  version: 1.0.0
extends: openapi/conga-product-option-components-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: 7
- target: $.paths['/product-option-group/{ParentId}/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List a bundle's option components
      effect: read
      questions:
      - How do I see every option group and option in a bundle product?
      - Which options are configured under a Conga CPQ bundle?
      - Can I filter the option components of a bundle?
      instructions:
      - text: List the option components for bundle {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Show option components of bundle {ParentId} matching {filter}.
        slots:
          ParentId: path.ParentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-option-group/{ParentId}/products'].post
  update:
    x-apievangelist-phrasing:
      intent: Add products and options to a bundle
      effect: write
      questions:
      - How do I add standalone products or sub-bundles to a bundle?
      - Can I add options to an option group already on a bundle?
      instructions:
      - text: Add these products and options to bundle {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Create new option components under {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-option-group/{ParentId}/products'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove option components from a bundle in bulk
      effect: destructive
      questions:
      - Is there a way to remove several products or options from a bundle at once?
      - Can I bulk delete options from an option group on a bundle?
      instructions:
      - text: Remove these option components from {ParentId} in bulk.
        slots:
          ParentId: path.ParentId
      - text: Delete several products and options from bundle {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-option-group/{ParentId}/products'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update option components in bulk
      effect: write
      questions:
      - How do I edit many option components in one request?
      - Can I bulk update the options under a bundle's option group?
      instructions:
      - text: Update several option components under {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Bulk edit the option components of {ParentId} with these changes.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-option-group/{ParentId}/products/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single option component
      effect: read
      questions:
      - How do I look up one option component by its ID?
      - What settings does a single option component have?
      instructions:
      - text: Get option component {Id} in option group {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Show the details of option component {Id} under {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-option-group/{ParentId}/products/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a single option component
      effect: destructive
      questions:
      - How do I delete just one option component?
      - Can I remove one specific option from an option group by ID?
      instructions:
      - text: Delete option component {Id} from option group {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Remove the single option component {Id} under {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-option-group/{ParentId}/products/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a single option component
      effect: write
      questions:
      - What's the call to change one option component's settings?
      - Can I edit a single option in an option group by its ID?
      instructions:
      - text: Update option component {Id} in option group {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit the single option component {Id} under {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'