Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Constraint Rule Conditions API

8 actions 8 updates phrasing extends openapi/conga-constraint-rule-conditions-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['/constraint-rules/{ParentId}/conditions'].get
$.paths['/constraint-rules/{ParentId}/conditions'].post
$.paths['/constraint-rules/{ParentId}/conditions'].delete
$.paths['/constraint-rules/{ParentId}/conditions'].patch
$.paths['/constraint-rules/{ParentId}/conditions/{Id}'].get
$.paths['/constraint-rules/{ParentId}/conditions/{Id}'].delete
$.paths['/constraint-rules/{ParentId}/conditions/{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 Conditions API
  version: 1.0.0
extends: openapi/conga-constraint-rule-conditions-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['/constraint-rules/{ParentId}/conditions'].get
  update:
    x-apievangelist-phrasing:
      intent: List conditions in a constraint rule
      effect: read
      questions:
      - Which conditions are defined on a constraint rule?
      - Can I filter and page through a constraint rule's conditions?
      instructions:
      - text: List the conditions in constraint rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Show conditions of rule {ParentId} matching {filter}.
        slots:
          ParentId: path.ParentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules/{ParentId}/conditions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add conditions to a constraint rule
      effect: write
      questions:
      - How do I create new conditions on a constraint rule?
      - Is there a maximum number of conditions I can create in one request?
      instructions:
      - text: Create these conditions in constraint rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Add one or more conditions to a constraint rule.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules/{ParentId}/conditions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several conditions from a constraint rule
      effect: destructive
      questions:
      - How do I remove multiple conditions from a constraint rule at once?
      - Can I bulk-delete constraint rule conditions?
      instructions:
      - text: Bulk-delete the listed conditions from constraint rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Remove a batch of constraint rule conditions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules/{ParentId}/conditions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several conditions in a constraint rule
      effect: write
      questions:
      - Can I edit fields on many constraint rule conditions together?
      - How do I bulk-update conditions on a rule?
      instructions:
      - text: Bulk-update conditions in constraint rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Apply these field changes to multiple constraint rule conditions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules/{ParentId}/conditions/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one condition in a constraint rule
      effect: read
      questions:
      - How do I view a single condition on a constraint rule?
      - Can I fetch one constraint rule condition by its ID?
      instructions:
      - text: Show condition {Id} in constraint rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Get details of rule condition {Id} under {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules/{ParentId}/conditions/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one condition from a constraint rule
      effect: destructive
      questions:
      - How do I delete a single condition from a constraint rule?
      - Can I remove only one rule condition by ID?
      instructions:
      - text: Delete condition {Id} from constraint rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Remove only rule condition {Id} under {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules/{ParentId}/conditions/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one condition in a constraint rule
      effect: write
      questions:
      - How do I change a single condition on a constraint rule?
      - Can I edit one rule condition without touching the rest?
      instructions:
      - text: Update condition {Id} in constraint rule {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit only rule condition {Id} under {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'