Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Deal Guidance Rules API

8 actions 8 updates phrasing extends openapi/conga-deal-guidance-rules-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-rules'].get
$.paths['/deal-guidance-rules'].post
$.paths['/deal-guidance-rules'].delete
$.paths['/deal-guidance-rules'].patch
$.paths['/deal-guidance-rules/{Id}'].get
$.paths['/deal-guidance-rules/{Id}'].delete
$.paths['/deal-guidance-rules/{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 Guidance Rules API
  version: 1.0.0
extends: openapi/conga-deal-guidance-rules-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-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List deal guidance rules
      effect: read
      questions:
      - Which deal guidance rules are configured in Conga CPQ?
      - Can I filter and sort the list of deal guidance rules?
      instructions:
      - text: List all deal guidance rules.
      - text: Find deal guidance rules matching {filter}, sorted by {sort}.
        slots:
          filter: query.filter
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create deal guidance rules
      effect: write
      questions:
      - How do I set up new deal guidance rules?
      - Can I create several deal guidance rules in one request?
      instructions:
      - text: Create a batch of new deal guidance rules from the details I provide.
      - text: Add a new deal guidance rule.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-rules'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several deal guidance rules
      effect: destructive
      questions:
      - Can I delete a list of deal guidance rules in one go?
      - What call bulk-removes deal guidance rules by their IDs?
      instructions:
      - text: Bulk-delete the deal guidance rules whose IDs are in the body.
      - text: Remove several deal guidance rules at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-rules'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several deal guidance rules
      effect: write
      questions:
      - Can I edit multiple deal guidance rules in a single batch?
      - Is there a bulk update for deal guidance rules?
      instructions:
      - text: Bulk-update a set of deal guidance rules with these changes.
      - text: Apply edits to many deal guidance rules in one request.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-rules/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deal guidance rule
      effect: read
      questions:
      - What does one particular deal guidance rule contain?
      - Can I fetch a single deal guidance rule with related records included?
      instructions:
      - text: Fetch deal guidance rule {Id}.
        slots:
          Id: path.Id
      - text: Show deal guidance rule {Id} including {includes}.
        slots:
          Id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-rules/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deal guidance rule
      effect: destructive
      questions:
      - How do I delete one deal guidance rule by ID?
      - Can I remove a single deal guidance rule without touching the others?
      instructions:
      - text: Delete deal guidance rule {Id}.
        slots:
          Id: path.Id
      - text: Remove only the deal guidance rule with ID {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-rules/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a deal guidance rule
      effect: write
      questions:
      - Can I change one deal guidance rule by its ID?
      - Which call edits a single deal guidance rule record?
      instructions:
      - text: Update deal guidance rule {Id} with these changes.
        slots:
          Id: path.Id
      - text: Edit only the single deal guidance rule {Id}.
        slots:
          Id: path.Id
      method: generated
      generated: '2026-10-01'