Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Approvals Rule Entries API

5 actions 5 updates phrasing extends openapi/conga-ruleentries-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 5

$.info

$.paths['/v1/rule-entries'].post

$.paths['/v1/rule-entries/reorder'].post

$.paths['/v1/rule-entries/validate'].get

$.paths['/v1/rule-entries/{id}'].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 Approvals Rule Entries API
  version: 1.0.0
extends: openapi/conga-ruleentries-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: 4
- target: $.paths['/v1/rule-entries'].post
  update:
    x-apievangelist-phrasing:
      intent: Save an approval rule entry
      effect: write
      questions:
      - How do I create or edit an entry in an approval rule?
      - Can I set the condition and assignees on a rule entry?
      instructions:
      - text: Save a rule entry labeled {EntryLabel} on approval rule {ApprovalRuleId}.
        slots:
          EntryLabel: requestBody.EntryLabel
          ApprovalRuleId: requestBody.ApprovalRuleId
      - text: Save rule entry {Id} with condition {Condition}.
        slots:
          Id: requestBody.Id
          Condition: requestBody.Condition
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/rule-entries/reorder'].post
  update:
    x-apievangelist-phrasing:
      intent: Reorder entries within an approval rule
      effect: write
      questions:
      - Can I change the order rule entries are evaluated in?
      - How do I resequence the entries of an approval rule?
      instructions:
      - text: Reorder the entries of this approval rule.
      - text: Resequence rule entries to the order I give.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/rule-entries/validate'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a rule entry label is taken
      effect: read
      questions:
      - Is a rule entry label already used in this rule?
      - How do I validate a rule entry label before saving?
      instructions:
      - text: Check whether label {ruleEntryLabel} is used in rule {ruleId}.
        slots:
          ruleEntryLabel: query.ruleEntryLabel
          ruleId: query.ruleId
      - text: Validate rule entry label {ruleEntryLabel} for rule {ruleId}.
        slots:
          ruleEntryLabel: query.ruleEntryLabel
          ruleId: query.ruleId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/rule-entries/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an approval rule entry
      effect: read
      questions:
      - How do I fetch a single approval rule entry?
      - What condition and assignees does a rule entry have?
      instructions:
      - text: Get rule entry {id}.
        slots:
          id: path.id
      - text: Show approval rule entry {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'