# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Administration Field Expressions API
  version: 1.0.0
extends: openapi/conga-field-expressions-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['/field-expressions'].get
  update:
    x-apievangelist-phrasing:
      intent: List field expressions
      effect: read
      questions:
      - What field expressions are defined?
      - Can I filter or page through field expressions?
      instructions:
      - text: List all field expressions.
      - text: List field expressions matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/field-expressions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create field expressions
      effect: write
      questions:
      - How do I create new field expressions?
      - Can I add several field expressions at once?
      instructions:
      - text: Create new field expressions.
      - text: Add a batch of field expressions.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/field-expressions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete field expressions in bulk
      effect: destructive
      questions:
      - Can I delete many field expressions at once?
      - How do I bulk-remove field expressions?
      instructions:
      - text: Bulk delete the selected field expressions.
      - text: Remove multiple field expressions in one call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/field-expressions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update field expressions in bulk
      effect: write
      questions:
      - Can I edit several field expressions in one call?
      - How do I bulk-update field expressions?
      instructions:
      - text: Bulk update the selected field expressions.
      - text: Edit many field expressions at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/field-expressions/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a field expression
      effect: read
      questions:
      - Where can I see one field expression's definition?
      - Can I include related data when fetching a field expression?
      instructions:
      - text: Get field expression {id}.
        slots:
          id: path.Id
      - text: Show field expression {id} including {includes}.
        slots:
          id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/field-expressions/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a field expression
      effect: destructive
      questions:
      - Can I delete a single field expression?
      - What happens when one field expression is removed?
      instructions:
      - text: Delete field expression {id}.
        slots:
          id: path.Id
      - text: Remove only the field expression {id}.
        slots:
          id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/field-expressions/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a field expression
      effect: write
      questions:
      - How do I edit one field expression?
      - Can I change a single field expression's formula?
      instructions:
      - text: Update field expression {id}.
        slots:
          id: path.Id
      - text: Edit only the field expression {id}.
        slots:
          id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/field-expressions/{id}/constraint-rule-actions'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up constraint rule actions for an expression
      effect: read
      questions:
      - Which constraint rule actions can a field expression reference?
      - Can I page through the ConstraintRuleAction lookup records?
      instructions:
      - text: Show the constraint rule action lookup records for field expression {id}.
        slots:
          id: path.id
      - text: Look up ConstraintRuleAction records available to expression {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/field-expressions/{parentId}/constraint-rule-action-expressions'].get
  update:
    x-apievangelist-phrasing:
      intent: List constraint rule action expressions
      effect: read
      questions:
      - What constraint rule action expressions sit under a field expression?
      - Can I filter the action expressions of a field expression?
      instructions:
      - text: List constraint rule action expressions under field expression {parent}.
        slots:
          parent: path.parentId
      - text: Show action expressions of {parent} matching {filter}.
        slots:
          parent: path.parentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/field-expressions/{parentId}/constraint-rule-action-expressions'].post
  update:
    x-apievangelist-phrasing:
      intent: Create constraint rule action expressions
      effect: write
      questions:
      - How do I add constraint rule action expressions to a field expression?
      - Can I create several action expressions at once?
      instructions:
      - text: Create constraint rule action expressions under field expression {parent}.
        slots:
          parent: path.parentId
      - text: Add new action expressions to {parent}.
        slots:
          parent: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/field-expressions/{parentId}/constraint-rule-action-expressions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete constraint rule action expressions in bulk
      effect: destructive
      questions:
      - Can I bulk-remove action expressions from a field expression?
      - How do I delete many constraint rule action expressions?
      instructions:
      - text: Bulk delete constraint rule action expressions under {parent}.
        slots:
          parent: path.parentId
      - text: Remove the selected action expressions from field expression {parent}.
        slots:
          parent: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/field-expressions/{parentId}/constraint-rule-action-expressions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update constraint rule action expressions in bulk
      effect: write
      questions:
      - Can I edit several action expressions in one request?
      - How do I bulk-update constraint rule action expressions?
      instructions:
      - text: Bulk update constraint rule action expressions under {parent}.
        slots:
          parent: path.parentId
      - text: Edit the selected action expressions on field expression {parent}.
        slots:
          parent: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/field-expressions/{parentId}/constraint-rule-action-expressions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a constraint rule action expression
      effect: read
      questions:
      - Where do I see one constraint rule action expression?
      - What does a single action expression contain?
      instructions:
      - text: Get constraint rule action expression {id} under {parent}.
        slots:
          id: path.id
          parent: path.parentId
      - text: Show action expression {id} of field expression {parent}.
        slots:
          id: path.id
          parent: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/field-expressions/{parentId}/constraint-rule-action-expressions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a constraint rule action expression
      effect: destructive
      questions:
      - Can I delete one constraint rule action expression?
      - How do I remove a single action expression?
      instructions:
      - text: Delete constraint rule action expression {id} under {parent}.
        slots:
          id: path.id
          parent: path.parentId
      - text: Remove only action expression {id} from {parent}.
        slots:
          id: path.id
          parent: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/field-expressions/{parentId}/constraint-rule-action-expressions/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a constraint rule action expression
      effect: write
      questions:
      - How do I edit one constraint rule action expression?
      - Can I change a single action expression?
      instructions:
      - text: Update constraint rule action expression {id} under {parent}.
        slots:
          id: path.id
          parent: path.parentId
      - text: Edit only action expression {id} of {parent}.
        slots:
          id: path.id
          parent: path.parentId
      method: generated
      generated: '2026-10-01'