Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Attribute Matrix Entries API

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

$.info
$.paths['/attribute-matrices/{ParentId}/entries'].get
$.paths['/attribute-matrices/{ParentId}/entries'].post
$.paths['/attribute-matrices/{ParentId}/entries'].delete
$.paths['/attribute-matrices/{ParentId}/entries'].patch
$.paths['/attribute-matrices/{ParentId}/entries/export'].get
$.paths['/attribute-matrices/{ParentId}/entries/import'].post
$.paths['/attribute-matrices/{ParentId}/entries/{id}'].get
$.paths['/attribute-matrices/{ParentId}/entries/{id}'].delete
$.paths['/attribute-matrices/{ParentId}/entries/{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 Matrix Entries API
  version: 1.0.0
extends: openapi/conga-attribute-matrix-entries-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: 9
- target: $.paths['/attribute-matrices/{ParentId}/entries'].get
  update:
    x-apievangelist-phrasing:
      intent: List the entries in an attribute matrix
      effect: read
      questions:
      - Which rows are currently defined in one of my attribute matrices?
      - Can I page through and filter the entries of an attribute matrix?
      - Where can I see every value combination stored in a Conga attribute matrix?
      instructions:
      - text: List the entries of attribute matrix {matrix}.
        slots:
          matrix: path.ParentId
      - text: Show {limit} entries from attribute matrix {matrix} matching {filter}.
        slots:
          limit: query.limit
          matrix: path.ParentId
          filter: query.filter
      - text: Page through attribute matrix {matrix} entries sorted by {sort}.
        slots:
          matrix: path.ParentId
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-matrices/{ParentId}/entries'].post
  update:
    x-apievangelist-phrasing:
      intent: Add several entries to an attribute matrix
      effect: write
      questions:
      - Is there a way to add a batch of new rows to an attribute matrix at once?
      - Can I create multiple attribute matrix entries in one JSON request?
      instructions:
      - text: Create a batch of new entries in attribute matrix {matrix}.
        slots:
          matrix: path.ParentId
      - text: Add these rows to attribute matrix {matrix} in one request.
        slots:
          matrix: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-matrices/{ParentId}/entries'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several entries from an attribute matrix
      effect: destructive
      questions:
      - Can I remove many attribute matrix rows in a single call?
      - What is the way to bulk-delete entries from one attribute matrix?
      instructions:
      - text: Bulk-delete the listed entries from attribute matrix {matrix}.
        slots:
          matrix: path.ParentId
      - text: Remove this set of rows from attribute matrix {matrix} all at once.
        slots:
          matrix: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-matrices/{ParentId}/entries'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several attribute matrix entries
      effect: write
      questions:
      - Can values on many attribute matrix rows be changed together?
      - Can I bulk-edit the entries of an attribute matrix?
      instructions:
      - text: Bulk-update the supplied entries in attribute matrix {matrix}.
        slots:
          matrix: path.ParentId
      - text: Apply these value changes to multiple rows of attribute matrix {matrix}.
        slots:
          matrix: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-matrices/{ParentId}/entries/export'].get
  update:
    x-apievangelist-phrasing:
      intent: Export attribute matrix entries to CSV
      effect: read
      questions:
      - Can I download an attribute matrix's entries as a CSV spreadsheet?
      - How do I export all rows of an attribute matrix to a file?
      instructions:
      - text: Export the entries of attribute matrix {matrix} as a CSV file.
        slots:
          matrix: path.ParentId
      - text: Download a CSV of every row in attribute matrix {matrix}.
        slots:
          matrix: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-matrices/{ParentId}/entries/import'].post
  update:
    x-apievangelist-phrasing:
      intent: Import attribute matrix entries from CSV
      effect: write
      questions:
      - Can I load attribute matrix rows from a CSV file instead of JSON?
      - What format does the CSV need when importing attribute matrix entries?
      instructions:
      - text: Import the CSV file {file} into attribute matrix {matrix}.
        slots:
          file: requestBody.file
          matrix: path.ParentId
      - text: Upload a spreadsheet of rows to attribute matrix {matrix}.
        slots:
          matrix: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-matrices/{ParentId}/entries/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one attribute matrix entry
      effect: read
      questions:
      - How do I look up a single row of an attribute matrix by its ID?
      - What values does a specific attribute matrix entry hold?
      instructions:
      - text: Get entry {entry} from attribute matrix {matrix}.
        slots:
          entry: path.id
          matrix: path.ParentId
      - text: Show me the details of matrix row {entry} in {matrix}.
        slots:
          entry: path.id
          matrix: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-matrices/{ParentId}/entries/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one attribute matrix entry
      effect: destructive
      questions:
      - How do I remove one specific row from an attribute matrix?
      - Is deleting a single attribute matrix entry by ID permanent?
      instructions:
      - text: Delete entry {entry} from attribute matrix {matrix}.
        slots:
          entry: path.id
          matrix: path.ParentId
      - text: Remove only the row {entry} in matrix {matrix}.
        slots:
          entry: path.id
          matrix: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-matrices/{ParentId}/entries/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one attribute matrix entry
      effect: write
      questions:
      - How do I edit the values on a single attribute matrix row?
      - Can I change just one entry of an attribute matrix by its ID?
      instructions:
      - text: Update entry {entry} in attribute matrix {matrix}.
        slots:
          entry: path.id
          matrix: path.ParentId
      - text: Change the values on matrix row {entry} of {matrix}.
        slots:
          entry: path.id
          matrix: path.ParentId
      method: generated
      generated: '2026-10-01'