Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Constraint Rule Actions API

16 actions 16 updates phrasing extends openapi/conga-constraint-rule-actions-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 16

$.info
$.paths['/constraint-rule-actions/{id}/field-expressions'].get
$.paths['/constraint-rule-actions/{parentId}/constraint-rule-action-expressions'].get
$.paths['/constraint-rule-actions/{parentId}/constraint-rule-action-expressions'].post
$.paths['/constraint-rule-actions/{parentId}/constraint-rule-action-expressions'].delete
$.paths['/constraint-rule-actions/{parentId}/constraint-rule-action-expressions'].patch
$.paths['/constraint-rule-actions/{parentId}/constraint-rule-action-expressions/{id}'].get
$.paths['/constraint-rule-actions/{parentId}/constraint-rule-action-expressions/{id}'].delete
$.paths['/constraint-rule-actions/{parentId}/constraint-rule-action-expressions/{id}'].patch
$.paths['/constraint-rules/{ParentId}/actions'].get
$.paths['/constraint-rules/{ParentId}/actions'].post
$.paths['/constraint-rules/{ParentId}/actions'].delete
$.paths['/constraint-rules/{ParentId}/actions'].patch
$.paths['/constraint-rules/{ParentId}/actions/{Id}'].get
$.paths['/constraint-rules/{ParentId}/actions/{Id}'].delete
$.paths['/constraint-rules/{ParentId}/actions/{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 Constraint Rule Actions API
  version: 1.0.0
extends: openapi/conga-constraint-rule-actions-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: 15
- target: $.paths['/constraint-rule-actions/{id}/field-expressions'].get
  update:
    x-apievangelist-phrasing:
      intent: Get lookup records for a field expression
      effect: read
      questions:
      - How do I see the lookup records behind a constraint rule action's field expression?
      - Can I page through the field expression lookups for an action?
      instructions:
      - text: Get field expression lookup records for action {id}.
        slots:
          id: path.id
      - text: Show page {page} of field expression lookups for {id}, {limit} at a time.
        slots:
          page: query.page
          id: path.id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rule-actions/{parentId}/constraint-rule-action-expressions'].get
  update:
    x-apievangelist-phrasing:
      intent: List expressions on a constraint rule action
      effect: read
      questions:
      - Which action expressions belong to a constraint rule action?
      - Can I filter the expressions defined on one rule action?
      instructions:
      - text: List action expressions in constraint rule action {parentId}.
        slots:
          parentId: path.parentId
      - text: Show action expressions on {parentId} matching {filter}.
        slots:
          parentId: path.parentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rule-actions/{parentId}/constraint-rule-action-expressions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add expressions to a constraint rule action
      effect: write
      questions:
      - How do I create action expressions inside a constraint rule action?
      - Can I add several expressions to one rule action at once?
      instructions:
      - text: Create these action expressions under rule action {parentId}.
        slots:
          parentId: path.parentId
      - text: Add new expressions to a constraint rule action.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rule-actions/{parentId}/constraint-rule-action-expressions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several expressions from a rule action
      effect: destructive
      questions:
      - How do I remove a batch of action expressions from a rule action?
      - Can I bulk-delete expressions on a constraint rule action?
      instructions:
      - text: Delete the listed action expressions from rule action {parentId}.
        slots:
          parentId: path.parentId
      - text: Bulk-remove action expressions from a constraint rule action.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rule-actions/{parentId}/constraint-rule-action-expressions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several expressions on a rule action
      effect: write
      questions:
      - Can I edit fields on many action expressions of one rule action together?
      - How do I bulk-update constraint rule action expressions?
      instructions:
      - text: Bulk-update action expressions under rule action {parentId}.
        slots:
          parentId: path.parentId
      - text: Apply these field changes to multiple action expressions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rule-actions/{parentId}/constraint-rule-action-expressions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one expression on a rule action
      effect: read
      questions:
      - How do I view a single action expression on a constraint rule action?
      - Can I fetch one specific rule action expression by its ID?
      instructions:
      - text: Show action expression {id} in rule action {parentId}.
        slots:
          id: path.id
          parentId: path.parentId
      - text: Get details of expression {id} under action {parentId}.
        slots:
          id: path.id
          parentId: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rule-actions/{parentId}/constraint-rule-action-expressions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one expression from a rule action
      effect: destructive
      questions:
      - How do I delete just one action expression from a rule action?
      - What's returned when a single constraint rule action expression is removed?
      instructions:
      - text: Delete action expression {id} from rule action {parentId}.
        slots:
          id: path.id
          parentId: path.parentId
      - text: Remove the single expression {id} on action {parentId}.
        slots:
          id: path.id
          parentId: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rule-actions/{parentId}/constraint-rule-action-expressions/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one expression on a rule action
      effect: write
      questions:
      - How do I change fields on a single rule action expression?
      - Can I edit one action expression without touching its siblings?
      instructions:
      - text: Update action expression {id} in rule action {parentId}.
        slots:
          id: path.id
          parentId: path.parentId
      - text: Edit only expression {id} under action {parentId}.
        slots:
          id: path.id
          parentId: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules/{ParentId}/actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List actions in a constraint rule
      effect: read
      questions:
      - Which actions are configured on a constraint rule?
      - Can I sort and filter the actions inside one constraint rule?
      instructions:
      - text: List the actions in constraint rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Show actions of constraint rule {ParentId} sorted by {sort}.
        slots:
          ParentId: path.ParentId
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules/{ParentId}/actions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add actions to a constraint rule
      effect: write
      questions:
      - How do I create new actions on a constraint rule?
      - Is there a limit on how many constraint rule actions I can create at once?
      instructions:
      - text: Create these actions in constraint rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Add one or more actions to a constraint rule.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules/{ParentId}/actions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several actions from a constraint rule
      effect: destructive
      questions:
      - How do I delete multiple actions from a constraint rule at once?
      - Can I clear out a batch of constraint rule actions in one call?
      instructions:
      - text: Bulk-delete the listed actions from constraint rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Remove multiple constraint rule actions together.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules/{ParentId}/actions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several actions in a constraint rule
      effect: write
      questions:
      - Can I update fields on many actions of a constraint rule together?
      - How do I bulk-edit constraint rule actions?
      instructions:
      - text: Bulk-update actions in constraint rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Apply these changes to multiple constraint rule actions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules/{ParentId}/actions/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one action in a constraint rule
      effect: read
      questions:
      - Where can I read the details of one action configured on a constraint rule itself?
      - Can I fetch one constraint rule action by its ID?
      instructions:
      - text: Show action {Id} in constraint rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Get details of constraint rule action {Id} under rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules/{ParentId}/actions/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one action from a constraint rule
      effect: destructive
      questions:
      - How do I delete a single action from a constraint rule?
      - Can I remove just one constraint rule action by ID?
      instructions:
      - text: Delete action {Id} from constraint rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Remove only constraint rule action {Id} under rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules/{ParentId}/actions/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one action in a constraint rule
      effect: write
      questions:
      - How do I change a single action on a constraint rule?
      - Can I edit one constraint rule action without affecting the others?
      instructions:
      - text: Update action {Id} in constraint rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit only constraint rule action {Id} under rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'