Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Price Dimensions API

9 actions 9 updates phrasing extends openapi/conga-price-dimensions-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 9

$.info

$.paths['/price-dimensions'].get

$.paths['/price-dimensions'].post

$.paths['/price-dimensions'].delete

$.paths['/price-dimensions'].patch

$.paths['/price-dimensions/{Id}'].get

$.paths['/price-dimensions/{Id}'].delete

$.paths['/price-dimensions/{Id}'].patch

$.paths['/price-dimensions/{name}/datasource-value'].get

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