# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Administration Hierarchies API
  version: 1.0.0
extends: openapi/conga-hierarchies-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: 14
- target: $.paths['/hierarchies'].get
  update:
    x-apievangelist-phrasing:
      intent: List catalog hierarchies
      effect: read
      questions:
      - Which catalog hierarchies exist?
      - Can I filter or page through hierarchies?
      instructions:
      - text: List all hierarchies.
      - text: List hierarchies matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hierarchies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create hierarchies
      effect: write
      questions:
      - How do I create a new catalog hierarchy?
      - Can I add several hierarchies at once?
      instructions:
      - text: Create new hierarchies.
      - text: Add a batch of catalog hierarchies.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hierarchies'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete hierarchies in bulk
      effect: destructive
      questions:
      - Can I delete multiple hierarchies at once?
      - How do I bulk-remove hierarchies?
      instructions:
      - text: Bulk delete the selected hierarchies.
      - text: Remove many hierarchies in one call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hierarchies'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update hierarchies in bulk
      effect: write
      questions:
      - Can I edit several hierarchies in one request?
      - How do I bulk-update hierarchies?
      instructions:
      - text: Bulk update the selected hierarchies.
      - text: Edit multiple hierarchies at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hierarchies/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a hierarchy
      effect: read
      questions:
      - Where can I see one hierarchy's details?
      - Can I include related records when fetching a hierarchy?
      instructions:
      - text: Get hierarchy {id}.
        slots:
          id: path.Id
      - text: Show hierarchy {id} including {includes}.
        slots:
          id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hierarchies/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a hierarchy
      effect: destructive
      questions:
      - Can I delete a single hierarchy?
      - What happens when one hierarchy is removed?
      instructions:
      - text: Delete hierarchy {id}.
        slots:
          id: path.Id
      - text: Remove only the hierarchy {id}.
        slots:
          id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hierarchies/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a hierarchy
      effect: write
      questions:
      - How do I edit one hierarchy?
      - Can I rename a single hierarchy?
      instructions:
      - text: Update hierarchy {id}.
        slots:
          id: path.Id
      - text: Edit only the hierarchy {id}.
        slots:
          id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hierarchies/{parentId}/price-list-categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List price list categories of a hierarchy
      effect: read
      questions:
      - Which price list categories are under a hierarchy?
      - Can I filter the price list categories of a hierarchy?
      instructions:
      - text: List price list categories of hierarchy {h}.
        slots:
          h: path.parentId
      - text: Show categories under hierarchy {h} matching {filter}.
        slots:
          h: path.parentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hierarchies/{parentId}/price-list-categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create price list categories
      effect: write
      questions:
      - How do I add price list categories to a hierarchy?
      - Can I create several categories under one hierarchy?
      instructions:
      - text: Create price list categories under hierarchy {h}.
        slots:
          h: path.parentId
      - text: Add new categories to hierarchy {h}.
        slots:
          h: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hierarchies/{parentId}/price-list-categories'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete price list categories in bulk
      effect: destructive
      questions:
      - Can I remove many price list categories from a hierarchy?
      - How do I bulk-delete hierarchy categories?
      instructions:
      - text: Bulk delete price list categories in hierarchy {h}.
        slots:
          h: path.parentId
      - text: Remove the selected categories from hierarchy {h}.
        slots:
          h: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hierarchies/{parentId}/price-list-categories'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update price list categories in bulk
      effect: write
      questions:
      - Can I edit several price list categories at once?
      - How do I bulk-update categories in a hierarchy?
      instructions:
      - text: Bulk update price list categories in hierarchy {h}.
        slots:
          h: path.parentId
      - text: Edit the selected categories under hierarchy {h}.
        slots:
          h: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hierarchies/{parentId}/price-list-categories/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a price list category
      effect: read
      questions:
      - Where do I see one price list category?
      - What does a single hierarchy category contain?
      instructions:
      - text: Get price list category {id} in hierarchy {h}.
        slots:
          id: path.id
          h: path.parentId
      - text: Show category {id} of hierarchy {h}.
        slots:
          id: path.id
          h: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hierarchies/{parentId}/price-list-categories/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a price list category
      effect: destructive
      questions:
      - Can I delete one price list category?
      - How do I remove a single category from a hierarchy?
      instructions:
      - text: Delete price list category {id} from hierarchy {h}.
        slots:
          id: path.id
          h: path.parentId
      - text: Remove only category {id} in hierarchy {h}.
        slots:
          id: path.id
          h: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/hierarchies/{parentId}/price-list-categories/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a price list category
      effect: write
      questions:
      - How do I edit one price list category?
      - Can I change a single category in a hierarchy?
      instructions:
      - text: Update price list category {id} in hierarchy {h}.
        slots:
          id: path.id
          h: path.parentId
      - text: Edit only category {id} of hierarchy {h}.
        slots:
          id: path.id
          h: path.parentId
      method: generated
      generated: '2026-10-01'