Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Product Attribute Rule Actions API

8 actions 8 updates phrasing extends openapi/conga-product-attribute-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 8

$.info
$.paths['/attribute-rules/{ParentId}/actions'].get
$.paths['/attribute-rules/{ParentId}/actions'].post
$.paths['/attribute-rules/{ParentId}/actions'].delete
$.paths['/attribute-rules/{ParentId}/actions'].patch
$.paths['/attribute-rules/{ParentId}/actions/{id}'].get
$.paths['/attribute-rules/{ParentId}/actions/{id}'].delete
$.paths['/attribute-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 Product Attribute Rule Actions API
  version: 1.0.0
extends: openapi/conga-product-attribute-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: 7
- target: $.paths['/attribute-rules/{ParentId}/actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List the actions of a product attribute rule
      effect: read
      questions:
      - How do I see the actions an attribute rule performs when it fires?
      - Can I filter or sort the actions defined on a product attribute rule?
      - Which actions are attached to a given Conga product attribute rule?
      instructions:
      - text: List all actions on attribute rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Show actions of product attribute rule {ParentId} matching {filter}.
        slots:
          ParentId: path.ParentId
          filter: query.filter
      - text: Get the first {limit} rule actions for attribute rule {ParentId}, sorted by {sort}.
        slots:
          limit: query.limit
          ParentId: path.ParentId
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-rules/{ParentId}/actions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add actions to a product attribute rule
      effect: write
      questions:
      - What's the way to add several actions to an attribute rule at once?
      - Can I create multiple product attribute rule actions in a single request?
      instructions:
      - text: Create a batch of new actions on attribute rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Add new rule actions to product attribute rule {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-rules/{ParentId}/actions'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete several actions from an attribute rule
      effect: destructive
      questions:
      - How can I bulk delete actions from a product attribute rule?
      - Is there a way to remove many attribute rule actions in one call?
      instructions:
      - text: Bulk delete several actions from attribute rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Remove a set of rule actions from product attribute rule {ParentId} in one request.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-rules/{ParentId}/actions'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several actions of an attribute rule
      effect: write
      questions:
      - Can I edit many attribute rule actions together in one bulk update?
      - What's the quickest way to change several actions on a product attribute rule?
      instructions:
      - text: Bulk update several actions on attribute rule {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Apply changes to multiple rule actions of product attribute rule {ParentId} at once.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-rules/{ParentId}/actions/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one action of a product attribute rule
      effect: read
      questions:
      - How do I look up a single attribute rule action by its ID?
      - What does one specific action on a product attribute rule do?
      instructions:
      - text: Get action {id} from attribute rule {ParentId}.
        slots:
          id: path.id
          ParentId: path.ParentId
      - text: Show the details of rule action {id} on product attribute rule {ParentId}.
        slots:
          id: path.id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-rules/{ParentId}/actions/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete one action from an attribute rule
      effect: destructive
      questions:
      - How do I delete just one action from an attribute rule?
      - Can I remove a single product attribute rule action by its ID?
      instructions:
      - text: Delete action {id} from attribute rule {ParentId}.
        slots:
          id: path.id
          ParentId: path.ParentId
      - text: Remove only rule action {id} on product attribute rule {ParentId}.
        slots:
          id: path.id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/attribute-rules/{ParentId}/actions/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update one action of an attribute rule
      effect: write
      questions:
      - What do I call to change a single attribute rule action?
      - Can I edit one specific action on a product attribute rule by its ID?
      instructions:
      - text: Update action {id} on attribute rule {ParentId}.
        slots:
          id: path.id
          ParentId: path.ParentId
      - text: Edit just rule action {id} of product attribute rule {ParentId}.
        slots:
          id: path.id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'