Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Deal Color Bands API

8 actions 8 updates phrasing extends openapi/conga-deal-color-bands-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-color-bands'].get
$.paths['/deal-guidance-color-bands'].post
$.paths['/deal-guidance-color-bands'].delete
$.paths['/deal-guidance-color-bands'].patch
$.paths['/deal-guidance-color-bands/{Id}'].get
$.paths['/deal-guidance-color-bands/{Id}'].delete
$.paths['/deal-guidance-color-bands/{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 Deal Color Bands API
  version: 1.0.0
extends: openapi/conga-deal-color-bands-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-color-bands'].get
  update:
    x-apievangelist-phrasing:
      intent: List deal guidance color bands
      effect: read
      questions:
      - Which color bands are set up for deal guidance rules?
      - Can I filter deal color bands by rule?
      - How do I page through every deal color band?
      instructions:
      - text: List all deal guidance color bands.
      - text: Show deal color bands matching {filter}.
        slots:
          filter: query.filter
      - text: List color bands sorted by {sort}, {limit} per page.
        slots:
          sort: query.sort
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-color-bands'].post
  update:
    x-apievangelist-phrasing:
      intent: Create deal color bands
      effect: write
      questions:
      - How do I add color bands with shapes and colors to tell deals apart?
      - Can I create several color bands in one request?
      instructions:
      - text: Create these deal guidance color bands with their shapes and colors.
      - text: Add a batch of new color bands for deal guidance.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-color-bands'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete deal color bands in bulk
      effect: destructive
      questions:
      - Can I delete multiple deal color bands at once?
      - What's the bulk option for removing color bands?
      instructions:
      - text: Delete every deal color band in this list.
      - text: Bulk-remove the color bands I listed.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-color-bands'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update deal color bands in bulk
      effect: write
      questions:
      - Can I change fields on several color bands in one request?
      - Which call updates many deal color bands together?
      instructions:
      - text: Bulk-update these deal color bands.
      - text: Apply field changes to multiple color bands at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-color-bands/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deal color band
      effect: read
      questions:
      - What shape and color does a particular deal color band use?
      - Can I fetch one color band by ID with related records?
      instructions:
      - text: Show deal color band {band_id}.
        slots:
          band_id: path.Id
      - text: Get color band {band_id} including {includes}.
        slots:
          band_id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-color-bands/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deal color band
      effect: destructive
      questions:
      - How do I remove one color band by its ID?
      - Can I delete a single deal color band without affecting others?
      instructions:
      - text: Delete deal color band {band_id}.
        slots:
          band_id: path.Id
      - text: Remove only color band {band_id}.
        slots:
          band_id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-color-bands/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a deal color band
      effect: write
      questions:
      - Can I change the color or shape of a single color band?
      - Which request edits one deal color band by ID?
      instructions:
      - text: Update deal color band {band_id}.
        slots:
          band_id: path.Id
      - text: Change the shape on color band {band_id}.
        slots:
          band_id: path.Id
      method: generated
      generated: '2026-10-01'