Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Price Matrices API

8 actions 8 updates phrasing extends openapi/conga-price-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['/matrices'].get

$.paths['/matrices'].post

$.paths['/matrices'].delete

$.paths['/matrices'].patch

$.paths['/matrices/{Id}'].get

$.paths['/matrices/{Id}'].delete

$.paths['/matrices/{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 Price Matrices API
  version: 1.0.0
extends: openapi/conga-price-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['/matrices'].get
  update:
    x-apievangelist-phrasing:
      intent: List price matrices
      effect: read
      questions:
      - Which price matrices are defined?
      - Can I filter or page through price matrices?
      instructions:
      - text: List all price matrices.
      - text: List price matrices matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/matrices'].post
  update:
    x-apievangelist-phrasing:
      intent: Create price matrices
      effect: write
      questions:
      - How do I create a new price matrix?
      - Can I add several price matrices at once?
      instructions:
      - text: Create new price matrices.
      - text: Add a batch of price matrices.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/matrices'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete price matrices in bulk
      effect: destructive
      questions:
      - Can I delete several price matrices at once?
      - How do I bulk-remove price matrices?
      instructions:
      - text: Bulk delete the selected price matrices.
      - text: Remove many price matrices in one call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/matrices'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update price matrices in bulk
      effect: write
      questions:
      - Can I edit multiple price matrices in one request?
      - How do I bulk-update price matrices?
      instructions:
      - text: Bulk update the selected price matrices.
      - text: Edit several price matrices at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/matrices/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a price matrix
      effect: read
      questions:
      - Where can I see one price matrix?
      - Can I include related entries when fetching a price matrix?
      instructions:
      - text: Get price matrix {id}.
        slots:
          id: path.Id
      - text: Show price matrix {id} including {includes}.
        slots:
          id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/matrices/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a price matrix
      effect: destructive
      questions:
      - Can I delete a single price matrix?
      - What happens when one price matrix is removed?
      instructions:
      - text: Delete price matrix {id}.
        slots:
          id: path.Id
      - text: Remove only the price matrix {id}.
        slots:
          id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/matrices/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a price matrix
      effect: write
      questions:
      - How do I edit one price matrix?
      - Can I change a single matrix's dimensions?
      instructions:
      - text: Update price matrix {id}.
        slots:
          id: path.Id
      - text: Edit only the price matrix {id}.
        slots:
          id: path.Id
      method: generated
      generated: '2026-10-01'