Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Deal Guidance Dimensions API

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

$.info

$.paths['/deal-guidance-dimensions'].get

$.paths['/deal-guidance-dimensions'].post

$.paths['/deal-guidance-dimensions'].delete

$.paths['/deal-guidance-dimensions'].patch

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

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

$.paths['/deal-guidance-dimensions/{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 Deal Guidance Dimensions API
  version: 1.0.0
extends: openapi/conga-deal-guidance-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: 7
- target: $.paths['/deal-guidance-dimensions'].get
  update:
    x-apievangelist-phrasing:
      intent: List deal guidance dimensions
      effect: read
      questions:
      - Which dimensions are defined for deal guidance rules?
      - Can I filter and page through deal guidance dimensions?
      instructions:
      - text: List all deal guidance dimensions.
      - text: Show {limit} deal guidance dimensions matching {filter}.
        slots:
          limit: query.limit
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-dimensions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create deal guidance dimensions
      effect: write
      questions:
      - How do I define new dimensions on a field for deal rule criteria?
      - Can I add several deal guidance dimensions in one request?
      instructions:
      - text: Create these deal guidance dimensions.
      - text: Add a batch of new dimensions for deal rule criteria.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-dimensions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete deal guidance dimensions in bulk
      effect: destructive
      questions:
      - Can I remove several deal guidance dimensions at once?
      - What is the bulk way to delete deal guidance dimensions?
      instructions:
      - text: Bulk-delete the listed deal guidance dimensions.
      - text: Remove this set of deal dimensions together.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-dimensions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update deal guidance dimensions in bulk
      effect: write
      questions:
      - Can I edit many deal guidance dimensions with one payload?
      - Is there a bulk update for deal guidance dimensions?
      instructions:
      - text: Bulk-update the supplied deal guidance dimensions.
      - text: Apply these changes to several deal dimensions at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-dimensions/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deal guidance dimension
      effect: read
      questions:
      - What field and settings does one deal guidance dimension use?
      - How do I look up a deal guidance dimension by its ID?
      instructions:
      - text: Get deal guidance dimension {dimension}.
        slots:
          dimension: path.Id
      - text: Show dimension {dimension} with related {includes}.
        slots:
          dimension: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-dimensions/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deal guidance dimension
      effect: destructive
      questions:
      - How do I delete one specific deal guidance dimension?
      - Is removing a single deal dimension permanent?
      instructions:
      - text: Delete deal guidance dimension {dimension}.
        slots:
          dimension: path.Id
      - text: Remove only the deal dimension {dimension}.
        slots:
          dimension: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-dimensions/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a deal guidance dimension
      effect: write
      questions:
      - How do I edit one deal guidance dimension?
      - Can I change the details of a single dimension record?
      instructions:
      - text: Update deal guidance dimension {dimension}.
        slots:
          dimension: path.Id
      - text: Change the details of deal dimension {dimension}.
        slots:
          dimension: path.Id
      method: generated
      generated: '2026-10-01'