# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Approvals Rules API
  version: 1.0.0
extends: openapi/conga-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: 12
- target: $.paths['/v1/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: Search approval rules for a business object
      effect: read
      questions:
      - Which approval rules exist for a business object, by name?
      - Can I filter approval rules to just the active ones and sort them?
      instructions:
      - text: Search approval rules on {businessObjectName}.
        slots:
          businessObjectName: query.businessObjectName
      - text: Find rules on {businessObjectName} matching {filter}.
        slots:
          businessObjectName: query.businessObjectName
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Save an approval rule
      effect: write
      questions:
      - How do I create an approval rule with its rule entries?
      - Can I write a rule definition with several entries at once?
      instructions:
      - text: 'Save an approval rule with these entries: {RuleEntries}.'
        slots:
          RuleEntries: requestBody.RuleEntries
      - text: Create a new approval rule from the entries I describe.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/rules/validate'].get
  update:
    x-apievangelist-phrasing:
      intent: Check whether a rule name is already used
      effect: read
      questions:
      - Is this rule name already taken for the object type?
      - Can I validate a rule name before I save the rule?
      instructions:
      - text: Check whether rule name {ruleName} exists for {businessObjectType}.
        slots:
          ruleName: query.ruleName
          businessObjectType: query.businessObjectType
      - text: Validate rule name {ruleName} on {businessObjectType} objects.
        slots:
          ruleName: query.ruleName
          businessObjectType: query.businessObjectType
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/rules/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an approval rule by ID
      effect: read
      questions:
      - What does one approval rule contain?
      - Can I fetch a rule and its entries by ID?
      instructions:
      - text: Show me approval rule {id}.
        slots:
          id: path.id
      - text: Fetch the definition of rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/rules/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an approval rule
      effect: destructive
      questions:
      - Can I permanently remove an approval rule?
      - What call deletes a whole rule rather than one entry?
      instructions:
      - text: Delete approval rule {id}.
        slots:
          id: path.id
      - text: Remove the entire rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/rules/{id}/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate an approval rule
      effect: write
      questions:
      - How do I turn an approval rule on?
      - Can I reactivate a rule I switched off earlier?
      instructions:
      - text: Activate approval rule {id}.
        slots:
          id: path.id
      - text: Turn on rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/rules/{id}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Copy an approval rule
      effect: write
      questions:
      - Can I duplicate a rule to use as a template?
      - Is there a way to copy an existing approval rule?
      instructions:
      - text: Clone approval rule {id}.
        slots:
          id: path.id
      - text: Make a copy of rule {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/rules/{id}/deactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate an approval rule
      effect: write
      questions:
      - Can I switch off a whole rule without deleting it?
      - What disables an approval rule temporarily?
      instructions:
      - text: Deactivate approval rule {id}.
        slots:
          id: path.id
      - text: Turn off rule {id} but keep it.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/rules/{id}/rule-entries/{ruleEntryId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an entry from an approval rule
      effect: destructive
      questions:
      - Can I remove just one entry from a rule?
      - What happens if I delete a single rule entry?
      instructions:
      - text: Delete entry {ruleEntryId} from rule {id}.
        slots:
          ruleEntryId: path.ruleEntryId
          id: path.id
      - text: Remove rule entry {ruleEntryId} in rule {id}.
        slots:
          ruleEntryId: path.ruleEntryId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/rules/{id}/rule-entries/{ruleEntryId}/activate'].post
  update:
    x-apievangelist-phrasing:
      intent: Activate an approval rule entry
      effect: write
      questions:
      - Can I turn on one entry inside a rule?
      - Which call re-enables a single rule entry?
      instructions:
      - text: Activate entry {ruleEntryId} in rule {id}.
        slots:
          ruleEntryId: path.ruleEntryId
          id: path.id
      - text: Switch on rule entry {ruleEntryId} of rule {id}.
        slots:
          ruleEntryId: path.ruleEntryId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/rules/{id}/rule-entries/{ruleEntryId}/deactivate'].post
  update:
    x-apievangelist-phrasing:
      intent: Deactivate an approval rule entry
      effect: write
      questions:
      - Can I disable one rule entry while leaving the rule active?
      - Is it possible to switch off a single entry in a rule?
      instructions:
      - text: Deactivate entry {ruleEntryId} in rule {id}.
        slots:
          ruleEntryId: path.ruleEntryId
          id: path.id
      - text: Switch off rule entry {ruleEntryId} of rule {id}.
        slots:
          ruleEntryId: path.ruleEntryId
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/rules/{id}/sequence/{ruleSequenceId}/unreferenced-steps'].get
  update:
    x-apievangelist-phrasing:
      intent: List rule entries available as dependencies
      effect: read
      questions:
      - Which rule entries could the current entry depend on?
      - What entries in a rule sequence are free to use as dependencies?
      instructions:
      - text: List entries available as dependencies for sequence {ruleSequenceId} in rule {id}.
        slots:
          ruleSequenceId: path.ruleSequenceId
          id: path.id
      - text: Show possible dependency entries for rule {id}, sequence {ruleSequenceId}.
        slots:
          id: path.id
          ruleSequenceId: path.ruleSequenceId
      method: generated
      generated: '2026-10-01'