Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Option Group Members API

8 actions 8 updates phrasing extends openapi/conga-option-group-members-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['/option-groups/{ParentId}/products'].get

$.paths['/option-groups/{ParentId}/products'].post

$.paths['/option-groups/{ParentId}/products'].delete

$.paths['/option-groups/{ParentId}/products'].patch

$.paths['/option-groups/{ParentId}/products/{Id}'].get

$.paths['/option-groups/{ParentId}/products/{Id}'].delete

$.paths['/option-groups/{ParentId}/products/{Id}'].patch

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 Group Members API
  version: 1.0.0
extends: openapi/conga-option-group-members-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['/option-groups/{ParentId}/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List option group members
      effect: read
      questions:
      - Which products are members of an option group?
      - Can I filter the products inside an option group?
      instructions:
      - text: List the member products of option group {group}.
        slots:
          group: path.ParentId
      - text: Show members of option group {group} matching {filter}.
        slots:
          group: path.ParentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/option-groups/{ParentId}/products'].post
  update:
    x-apievangelist-phrasing:
      intent: Add products to an option group
      effect: write
      questions:
      - How do I add products as options in a group?
      - Can I add several members to an option group at once?
      instructions:
      - text: Add member products to option group {group}.
        slots:
          group: path.ParentId
      - text: Create new members in option group {group}.
        slots:
          group: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/option-groups/{ParentId}/products'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove option group members in bulk
      effect: destructive
      questions:
      - Can I remove many products from an option group?
      - How do I bulk-delete option group members?
      instructions:
      - text: Bulk delete members of option group {group}.
        slots:
          group: path.ParentId
      - text: Remove the selected products from option group {group}.
        slots:
          group: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/option-groups/{ParentId}/products'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update option group members in bulk
      effect: write
      questions:
      - Can I edit several option group members in one call?
      - How do I bulk-update products in an option group?
      instructions:
      - text: Bulk update members of option group {group}.
        slots:
          group: path.ParentId
      - text: Edit the selected products in option group {group}.
        slots:
          group: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/option-groups/{ParentId}/products/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an option group member
      effect: read
      questions:
      - Where can I see one option group member?
      - What settings does a single option product have?
      instructions:
      - text: Get member {id} of option group {group}.
        slots:
          id: path.Id
          group: path.ParentId
      - text: Show option product {id} in group {group}.
        slots:
          id: path.Id
          group: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/option-groups/{ParentId}/products/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an option group member
      effect: destructive
      questions:
      - Can I remove a single product from an option group?
      - How do I delete one option group member?
      instructions:
      - text: Delete member {id} from option group {group}.
        slots:
          id: path.Id
          group: path.ParentId
      - text: Remove only option product {id} from {group}.
        slots:
          id: path.Id
          group: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/option-groups/{ParentId}/products/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an option group member
      effect: write
      questions:
      - How do I edit one option group member?
      - Can I change a single option product's settings?
      instructions:
      - text: Update member {id} of option group {group}.
        slots:
          id: path.Id
          group: path.ParentId
      - text: Edit only option product {id} in {group}.
        slots:
          id: path.Id
          group: path.ParentId
      method: generated
      generated: '2026-10-01'