Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Attribute Matrices API

8 actions 8 updates phrasing extends openapi/conga-attribute-matrices-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-matrices'].get
$.paths['/attribute-matrices'].post
$.paths['/attribute-matrices'].delete
$.paths['/attribute-matrices'].patch
$.paths['/attribute-matrices/{Id}'].get
$.paths['/attribute-matrices/{Id}'].delete
$.paths['/attribute-matrices/{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 Attribute Matrices API
  version: 1.0.0
extends: openapi/conga-attribute-matrices-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-matrices'].get
  update:
    x-apievangelist-phrasing:
      intent: List attribute matrices
      effect: read
      questions:
      - Which attribute matrices exist in my Conga CPQ org?
      - Can I narrow the attribute matrix list to one product or one attribute?
      - How do I page through all attribute matrices?
      instructions:
      - text: List all attribute matrices in the system.
      - text: Find attribute matrices matching filter {filter}, {limit} per page.
        slots:
          filter: query.filter
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-matrices'].post
  update:
    x-apievangelist-phrasing:
      intent: Create attribute matrices
      effect: write
      questions:
      - Can I create several product-scoped attribute matrices in one request?
      - Is it possible to create an attribute matrix that starts out deactivated?
      instructions:
      - text: Create a batch of new attribute matrices from the details I give you.
      - text: Set up a new product-scope attribute matrix and leave it inactive for now.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-matrices'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several attribute matrices
      effect: destructive
      questions:
      - Can I delete a whole list of attribute matrices at once by their IDs?
      - What call bulk-removes attribute matrices?
      instructions:
      - text: Bulk-delete the attribute matrices whose IDs I list in the body.
      - text: Remove several attribute matrices in one call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-matrices'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several attribute matrices
      effect: write
      questions:
      - Can I edit multiple attribute matrices in a single batch?
      - What does a bulk attribute matrix update return?
      instructions:
      - text: Bulk-update a set of attribute matrices with the changes in the body.
      - text: Apply edits to many attribute matrices at once and return their IDs.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-matrices/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an attribute matrix
      effect: read
      questions:
      - What does one particular attribute matrix record contain?
      - Can I pull a single attribute matrix with its related records included?
      instructions:
      - text: Fetch attribute matrix {Id}.
        slots:
          Id: path.Id
      - text: Show attribute matrix {Id} including {includes}.
        slots:
          Id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-matrices/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an attribute matrix
      effect: destructive
      questions:
      - How do I delete one attribute matrix by its ID?
      - Can I remove a single attribute matrix without affecting the others?
      instructions:
      - text: Delete attribute matrix {Id}.
        slots:
          Id: path.Id
      - text: Remove only the attribute matrix with ID {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-matrices/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an attribute matrix
      effect: write
      questions:
      - Can I change one attribute matrix by its identifier?
      - Which call edits a single attribute matrix record?
      instructions:
      - text: Update attribute matrix {Id} with these changes.
        slots:
          Id: path.Id
      - text: Edit only the single attribute matrix {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'