Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Attribute Groups API

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

$.info

$.paths['/attribute-groups'].get

$.paths['/attribute-groups'].post

$.paths['/attribute-groups'].delete

$.paths['/attribute-groups'].patch

$.paths['/attribute-groups/{Id}'].get

$.paths['/attribute-groups/{Id}'].delete

$.paths['/attribute-groups/{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 Attribute Groups API
  version: 1.0.0
extends: openapi/conga-attribute-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: 7
- target: $.paths['/attribute-groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List attribute groups
      effect: read
      questions:
      - Which attribute groups exist in my Conga product catalog?
      - Can I filter, sort and page the collection of attribute groups?
      - How do I see every attribute group with a limit on results per page?
      instructions:
      - text: List all attribute groups.
      - text: Show attribute groups matching {filter}.
        slots:
          filter: query.filter
      - text: List attribute groups sorted by {sort}, page {page}.
        slots:
          sort: query.sort
          page: query.page
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create attribute groups in bulk
      effect: write
      questions:
      - Can I create several new attribute groups in one request?
      - What does the response contain after I add a batch of attribute groups?
      instructions:
      - text: Create these new attribute groups in one bulk request.
      - text: Add a batch of attribute groups from the details I provide.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-groups'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete attribute groups in bulk
      effect: destructive
      questions:
      - Is it possible to delete multiple attribute groups at once?
      - What gets removed when a list of attribute groups is bulk-deleted?
      instructions:
      - text: Delete every attribute group in this list.
      - text: Bulk-remove the attribute groups I named in a single call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-groups'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update attribute groups in bulk
      effect: write
      questions:
      - Can I edit many attribute groups in one bulk update?
      - Which request changes fields on several attribute groups together?
      instructions:
      - text: Bulk-update the listed attribute groups with these changes.
      - text: Apply new details to multiple attribute groups in one request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-groups/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one attribute group
      effect: read
      questions:
      - What details are stored on a single attribute group?
      - Can I include related records when fetching one attribute group by ID?
      instructions:
      - text: Show attribute group {group_id}.
        slots:
          group_id: path.Id
      - text: Fetch attribute group {group_id} with {includes} included.
        slots:
          group_id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-groups/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one attribute group
      effect: destructive
      questions:
      - How do I remove a single attribute group by its ID?
      - Can I delete just one attribute group without touching the rest?
      instructions:
      - text: Delete attribute group {group_id}.
        slots:
          group_id: path.Id
      - text: Remove only the attribute group with ID {group_id}.
        slots:
          group_id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-groups/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one attribute group
      effect: write
      questions:
      - Can I rename or edit one particular attribute group by its ID?
      - Which call changes a single attribute group record?
      instructions:
      - text: Update attribute group {group_id} with these changes.
        slots:
          group_id: path.Id
      - text: Edit only attribute group {group_id}.
        slots:
          group_id: path.Id
      method: generated
      generated: '2026-10-01'