Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Administration Related Price List Items API

8 actions 8 updates phrasing extends openapi/conga-related-price-list-items-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['/price-list-items/{ParentId}/related-price-list-items'].get
$.paths['/price-list-items/{ParentId}/related-price-list-items'].post
$.paths['/price-list-items/{ParentId}/related-price-list-items'].delete
$.paths['/price-list-items/{ParentId}/related-price-list-items'].patch
$.paths['/price-list-items/{ParentId}/related-price-list-items/{Id}'].get
$.paths['/price-list-items/{ParentId}/related-price-list-items/{Id}'].delete
$.paths['/price-list-items/{ParentId}/related-price-list-items/{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 Related Price List Items API
  version: 1.0.0
extends: openapi/conga-related-price-list-items-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['/price-list-items/{ParentId}/related-price-list-items'].get
  update:
    x-apievangelist-phrasing:
      intent: List a price list item's related items
      effect: read
      questions:
      - Which price list items are related to a given price list item?
      - Can I filter or page the related price list items?
      instructions:
      - text: List the related price list items of {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Show items related to price list item {ParentId}, sorted by {sort}.
        slots:
          ParentId: path.ParentId
          sort: query.sort
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-list-items/{ParentId}/related-price-list-items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add related price list items
      effect: write
      questions:
      - How do I relate other price list items to a price list item?
      - Can I create several related price list items in one call?
      instructions:
      - text: Add related price list items to {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Link new related items under price list item {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-list-items/{ParentId}/related-price-list-items'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove several related price list items
      effect: destructive
      questions:
      - Can I delete multiple related price list items at once?
      - What's the way to clear a batch of related items from a price list item?
      instructions:
      - text: Delete several related items from price list item {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Bulk-remove related price list items under {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-list-items/{ParentId}/related-price-list-items'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update several related price list items
      effect: write
      questions:
      - Is there a bulk update for related price list items?
      - Can I reassign related items to another parent while updating them?
      instructions:
      - text: Bulk-update the related items of price list item {ParentId}.
        slots:
          ParentId: path.ParentId
      - text: Apply changes to several related price list items under {ParentId}.
        slots:
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-list-items/{ParentId}/related-price-list-items/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a related price list item
      effect: read
      questions:
      - How do I look up one related price list item?
      - What does a single related price list item record contain?
      instructions:
      - text: Get related price list item {Id} of {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Show related item {Id} under price list item {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-list-items/{ParentId}/related-price-list-items/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a related price list item
      effect: destructive
      questions:
      - How do I remove one related price list item?
      - Can I delete a single related price list item by its ID?
      instructions:
      - text: Delete related price list item {Id} from {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Unlink related item {Id} under price list item {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-list-items/{ParentId}/related-price-list-items/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a related price list item
      effect: write
      questions:
      - How do I edit a single related price list item?
      - Can I change one related price list item without touching the others?
      instructions:
      - text: Update related price list item {Id} of {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      - text: Edit related item {Id} under price list item {ParentId}.
        slots:
          Id: path.Id
          ParentId: path.ParentId
      method: generated
      generated: '2026-10-01'