Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Product Groups API

19 actions 19 updates phrasing extends openapi/conga-product-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 19 · first 16 shown; the file carries all of them

$.info
$.paths['/product-groups'].get
$.paths['/product-groups'].post
$.paths['/product-groups'].delete
$.paths['/product-groups'].patch
$.paths['/product-groups/{Id}'].get
$.paths['/product-groups/{Id}'].delete
$.paths['/product-groups/{Id}'].patch
$.paths['/product-groups/{id}/attribute-matrices'].get
$.paths['/product-groups/{id}/attribute-rules'].get
$.paths['/product-groups/{id}/constraint-rules'].get
$.paths['/product-groups/{id}/products'].get
$.paths['/product-groups/{parentId}/product-group-members'].get
$.paths['/product-groups/{parentId}/product-group-members'].post
$.paths['/product-groups/{parentId}/product-group-members'].delete
$.paths['/product-groups/{parentId}/product-group-members'].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 Groups API
  version: 1.0.0
extends: openapi/conga-product-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: 18
- target: $.paths['/product-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List product groups
      effect: read
      questions:
      - How do I see every product group set up in Conga CPQ?
      - Can I filter and sort the full list of product groups?
      - Which product groups exist in my catalog right now?
      instructions:
      - text: List all product groups in the catalog.
      - text: List product groups matching {filter}, sorted by {sort}.
        slots:
          filter: query.filter
          sort: query.sort
      - text: Show page {page} of product groups, {limit} per page.
        slots:
          page: query.page
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create product groups in bulk
      effect: write
      questions:
      - What's the way to create several new product groups in one request?
      - Can I add a batch of product groups to the catalog at once?
      instructions:
      - text: Create a batch of new product groups from this list.
      - text: Add several new product groups to the catalog in one call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-groups'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete product groups in bulk
      effect: destructive
      questions:
      - Is there a way to remove many product groups at the same time?
      - Can I bulk delete a set of product group records?
      instructions:
      - text: Delete these product groups in bulk.
      - text: Remove several product group records at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-groups'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update product groups in bulk
      effect: write
      questions:
      - Is it possible to edit several product groups in a single request?
      - Can I bulk update fields across many product groups?
      instructions:
      - text: Update these product groups in bulk with the changes listed.
      - text: Apply field changes to several product groups at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-groups/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product group
      effect: read
      questions:
      - How do I look up the details of one product group by its ID?
      - What does a single product group record contain?
      instructions:
      - text: Get the details of product group {Id}.
        slots:
          Id: path.Id
      - text: Show product group {Id} including {includes}.
        slots:
          Id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-groups/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a product group
      effect: destructive
      questions:
      - What happens when I delete one specific product group?
      - Can I remove a single product group by its ID?
      instructions:
      - text: Delete product group {Id}.
        slots:
          Id: path.Id
      - text: Remove the product group with ID {Id} from the catalog.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-groups/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a product group
      effect: write
      questions:
      - Where do I change the details of one product group?
      - Can I rename or edit a single product group by ID?
      instructions:
      - text: Update product group {Id} with these changes.
        slots:
          Id: path.Id
      - text: Edit the fields on product group {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-groups/{id}/attribute-matrices'].get
  update:
    x-apievangelist-phrasing:
      intent: List a product group's attribute matrices
      effect: read
      questions:
      - Which attribute matrices apply to a product group?
      - How do I see the attribute matrix records for a product group?
      instructions:
      - text: List the attribute matrices for product group {id}.
        slots:
          id: path.id
      - text: Show attribute matrix records tied to product group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-groups/{id}/attribute-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a product group's attribute rules
      effect: read
      questions:
      - What attribute rules are defined for a product group?
      - Can I page through the attribute rules on a product group?
      instructions:
      - text: List the attribute rules for product group {id}.
        slots:
          id: path.id
      - text: Show page {page} of attribute rules on product group {id}.
        slots:
          id: path.id
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-groups/{id}/constraint-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List a product group's constraint rules
      effect: read
      questions:
      - Which constraint rules reference a product group?
      - How do I find the constraint rule records for a product group?
      instructions:
      - text: List the constraint rules for product group {id}.
        slots:
          id: path.id
      - text: Show constraint rule records attached to product group {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-groups/{id}/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List products in a product group
      effect: read
      questions:
      - Which products belong to a given product group?
      - How do I get the products inside a product group a page at a time?
      instructions:
      - text: List the products in product group {id}.
        slots:
          id: path.id
      - text: Show {limit} products from product group {id}.
        slots:
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-groups/{parentId}/product-group-members'].get
  update:
    x-apievangelist-phrasing:
      intent: List a product group's members
      effect: read
      questions:
      - How do I see the member records of a product group?
      - Can I filter the members of a product group?
      instructions:
      - text: List the members of product group {parentId}.
        slots:
          parentId: path.parentId
      - text: List members of product group {parentId} matching {filter}.
        slots:
          parentId: path.parentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-groups/{parentId}/product-group-members'].post
  update:
    x-apievangelist-phrasing:
      intent: Add members to a product group
      effect: write
      questions:
      - What's the call to add products as members of a product group?
      - Can I create several product group members in one call?
      instructions:
      - text: Add these members to product group {parentId}.
        slots:
          parentId: path.parentId
      - text: Create several new member records under product group {parentId}.
        slots:
          parentId: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-groups/{parentId}/product-group-members'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove members from a product group in bulk
      effect: destructive
      questions:
      - How do I remove several members from a product group at once?
      - Can I bulk delete product group member records?
      instructions:
      - text: Remove these members from product group {parentId} in bulk.
        slots:
          parentId: path.parentId
      - text: Delete several member records from product group {parentId}.
        slots:
          parentId: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-groups/{parentId}/product-group-members'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update product group members in bulk
      effect: write
      questions:
      - How do I edit many product group members in one request?
      - Can I bulk update member fields within a product group?
      instructions:
      - text: Update several members of product group {parentId} with these changes.
        slots:
          parentId: path.parentId
      - text: Bulk edit member records in product group {parentId}.
        slots:
          parentId: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-groups/{parentId}/product-group-members/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product group member
      effect: read
      questions:
      - How do I look up one specific member of a product group?
      - What details are stored on a single product group member?
      instructions:
      - text: Get member {id} of product group {parentId}.
        slots:
          id: path.id
          parentId: path.parentId
      - text: Show the details of product group member {id} in group {parentId}.
        slots:
          id: path.id
          parentId: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-groups/{parentId}/product-group-members/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a single product group member
      effect: destructive
      questions:
      - How do I remove just one member from a product group?
      - Can I delete a single product group member by its ID?
      instructions:
      - text: Remove member {id} from product group {parentId}.
        slots:
          id: path.id
          parentId: path.parentId
      - text: Delete the single product group member {id} under group {parentId}.
        slots:
          id: path.id
          parentId: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/product-groups/{parentId}/product-group-members/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a single product group member
      effect: write
      questions:
      - How do I change one member record within a product group?
      - Can I edit a single product group member by ID?
      instructions:
      - text: Update member {id} of product group {parentId}.
        slots:
          id: path.id
          parentId: path.parentId
      - text: Edit the fields on product group member {id} in group {parentId}.
        slots:
          id: path.id
          parentId: path.parentId
      method: generated
      generated: '2026-10-01'