Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Constraint Rules API

8 actions 8 updates phrasing extends openapi/conga-constraint-rules-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'].get
$.paths['/constraint-rules'].post
$.paths['/constraint-rules'].delete
$.paths['/constraint-rules'].patch
$.paths['/constraint-rules/{Id}'].get
$.paths['/constraint-rules/{Id}'].delete
$.paths['/constraint-rules/{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 Rules API
  version: 1.0.0
extends: openapi/conga-constraint-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: 7
- target: $.paths['/constraint-rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List constraint rules
      effect: read
      questions:
      - Which product constraint rules are configured?
      - Can I filter and page through constraint rules?
      instructions:
      - text: List all constraint rules.
      - text: Show {limit} constraint rules matching {filter}.
        slots:
          limit: query.limit
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules'].post
  update:
    x-apievangelist-phrasing:
      intent: Create constraint rules in bulk
      effect: write
      questions:
      - How do I create up to 1000 constraint rules in one request?
      - Can I add several product constraint rules at once?
      instructions:
      - text: Create these constraint rules in one batch.
      - text: Add a new set of constraint rules from this payload.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete constraint rules in bulk
      effect: destructive
      questions:
      - How many constraint rules can I delete in a single call?
      - What happens to related records when I bulk-delete constraint rules?
      instructions:
      - text: Bulk-delete the listed constraint rules.
      - text: Remove this whole batch of constraint rules.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update constraint rules in bulk
      effect: write
      questions:
      - Can I change fields on many constraint rules together?
      - Which constraint rule fields can't be updated in a bulk edit?
      instructions:
      - text: Bulk-update fields on the listed constraint rules.
      - text: Apply these field changes to several constraint rules at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a constraint rule
      effect: read
      questions:
      - How do I look up one constraint rule by its ID?
      - What conditions and actions does a specific constraint rule have?
      instructions:
      - text: Get constraint rule {rule}.
        slots:
          rule: path.Id
      - text: Show constraint rule {rule} including {includes}.
        slots:
          rule: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a constraint rule
      effect: destructive
      questions:
      - How do I delete one specific constraint rule?
      - Which permissions do I need to remove a single constraint rule?
      instructions:
      - text: Delete constraint rule {rule}.
        slots:
          rule: path.Id
      - text: Remove only the constraint rule {rule}.
        slots:
          rule: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/constraint-rules/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a constraint rule
      effect: write
      questions:
      - How do I change fields on a single constraint rule?
      - Can I edit one constraint rule by its ID?
      instructions:
      - text: Update constraint rule {rule}.
        slots:
          rule: path.Id
      - text: Change the fields on constraint rule {rule}.
        slots:
          rule: path.Id
      method: generated
      generated: '2026-10-01'