Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Deal Guidance Rule Entries API

8 actions 8 updates phrasing extends openapi/conga-deal-guidance-rule-entries-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/{ParentId}/entries'].get

$.paths['/deal-guidance-rules/{ParentId}/entries'].post

$.paths['/deal-guidance-rules/{ParentId}/entries'].delete

$.paths['/deal-guidance-rules/{ParentId}/entries'].patch

$.paths['/deal-guidance-rules/{ParentId}/entries/{Id}'].get

$.paths['/deal-guidance-rules/{ParentId}/entries/{Id}'].delete

$.paths['/deal-guidance-rules/{ParentId}/entries/{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 Rule Entries API
  version: 1.0.0
extends: openapi/conga-deal-guidance-rule-entries-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/{ParentId}/entries'].get
  update:
    x-apievangelist-phrasing:
      intent: List entries of a deal guidance rule
      effect: read
      questions:
      - Which entries make up a particular deal guidance rule?
      - Can I filter and page the entries of a guidance rule?
      instructions:
      - text: List entries of deal guidance rule {rule_id}.
        slots:
          rule_id: path.ParentId
      - text: Show entries of rule {rule_id} matching {filter}.
        slots:
          rule_id: path.ParentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-rules/{ParentId}/entries'].post
  update:
    x-apievangelist-phrasing:
      intent: Add entries to a deal guidance rule
      effect: write
      questions:
      - How do I add new entries to a deal guidance rule?
      - Can I create several rule entries at once?
      instructions:
      - text: Add these entries to deal guidance rule {rule_id}.
        slots:
          rule_id: path.ParentId
      - text: Create new rule entries under guidance rule {rule_id}.
        slots:
          rule_id: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-rules/{ParentId}/entries'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete entries from a deal guidance rule
      effect: destructive
      questions:
      - Can I remove several entries from a deal guidance rule in one call?
      - What's the bulk way to clear rule entries?
      instructions:
      - text: Delete the listed entries from deal guidance rule {rule_id}.
        slots:
          rule_id: path.ParentId
      - text: Bulk-remove entries of guidance rule {rule_id}.
        slots:
          rule_id: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-rules/{ParentId}/entries'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update entries of a deal guidance rule
      effect: write
      questions:
      - Can I edit several entries of a guidance rule together?
      - Which request updates many rule entries at once?
      instructions:
      - text: Bulk-update entries of deal guidance rule {rule_id}.
        slots:
          rule_id: path.ParentId
      - text: Apply changes to multiple entries in guidance rule {rule_id}.
        slots:
          rule_id: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-rules/{ParentId}/entries/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a deal guidance rule entry
      effect: read
      questions:
      - What does one specific entry in a deal guidance rule contain?
      - Can I fetch a single rule entry by ID?
      instructions:
      - text: Show entry {entry_id} of deal guidance rule {rule_id}.
        slots:
          rule_id: path.ParentId
          entry_id: path.Id
      - text: Get rule entry {entry_id} under {rule_id}.
        slots:
          rule_id: path.ParentId
          entry_id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-rules/{ParentId}/entries/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a deal guidance rule entry
      effect: destructive
      questions:
      - How do I delete just one entry from a guidance rule?
      - Does removing one rule entry leave the rest intact?
      instructions:
      - text: Delete entry {entry_id} from deal guidance rule {rule_id}.
        slots:
          rule_id: path.ParentId
          entry_id: path.Id
      - text: Remove only rule entry {entry_id} of {rule_id}.
        slots:
          rule_id: path.ParentId
          entry_id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/deal-guidance-rules/{ParentId}/entries/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a deal guidance rule entry
      effect: write
      questions:
      - Can I change a single entry in a deal guidance rule?
      - Which call edits one rule entry by ID?
      instructions:
      - text: Update entry {entry_id} of deal guidance rule {rule_id}.
        slots:
          rule_id: path.ParentId
          entry_id: path.Id
      - text: Edit just rule entry {entry_id} under {rule_id}.
        slots:
          rule_id: path.ParentId
          entry_id: path.Id
      method: generated
      generated: '2026-10-01'