API Evangelist conversational phrasing for Admin API V1 Category Related Products API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Category Related Products API
  version: 1.0.0
extends: openapi/optimizely-category-related-products-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/api/v1/admin/CategoryRelatedProducts'].get
  update:
    x-apievangelist-phrasing:
      intent: List category related products
      effect: read
      questions:
      - Which products are linked as related products to my catalog categories?
      - Can I filter category related products to a single category?
      - How many category-to-product relations are set up?
      instructions:
      - text: List all category related products.
      - text: List category related products matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} category related products ordered by {orderby}.
        slots:
          top: query.$top
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryRelatedProducts'].post
  update:
    x-apievangelist-phrasing:
      intent: Relate a product to a category
      effect: write
      questions:
      - How do I link a related product to a category?
      - Can I set a sort order when relating a product to a category?
      instructions:
      - text: Relate product {productId} to category {categoryId}.
        slots:
          productId: requestBody.productId
          categoryId: requestBody.categoryId
      - text: Add product {productId} to category {categoryId} at sort order {sortOrder}.
        slots:
          productId: requestBody.productId
          categoryId: requestBody.categoryId
          sortOrder: requestBody.sortOrder
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryRelatedProducts({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a category related product link
      effect: read
      questions:
      - What category and product does one related-product record connect?
      - Can I fetch one category related product by its ID?
      instructions:
      - text: Get category related product {id}.
        slots:
          id: path.id
      - text: Show the category-product link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryRelatedProducts({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a category related product link
      effect: write
      questions:
      - How do I overwrite a category related product record completely?
      - Does replacing a category-product link reset fields I leave out?
      instructions:
      - text: Replace category related product {id} so it links product {productId} to category {categoryId}.
        slots:
          id: path.id
          productId: requestBody.productId
          categoryId: requestBody.categoryId
      - text: Overwrite all fields of category-product link {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryRelatedProducts({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a category related product link
      effect: destructive
      questions:
      - Can I unlink a related product from a category by the record ID?
      - Is it possible to delete a category-product link only if the ETag matches?
      instructions:
      - text: Delete category related product {id}.
        slots:
          id: path.id
      - text: Delete category-product link {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryRelatedProducts({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a category related product link
      effect: write
      questions:
      - How do I change the position of a related product within a category?
      - Can I change the relation type on an existing category-product link?
      instructions:
      - text: Set the sort order of category related product {id} to {sortOrder}.
        slots:
          id: path.id
          sortOrder: requestBody.sortOrder
      - text: Change the relation type of category-product link {id} to system list value {systemListValueId}.
        slots:
          id: path.id
          systemListValueId: requestBody.systemListValueId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CategoryRelatedProducts/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank category related product template
      effect: read
      questions:
      - What default values does a new category related product have?
      - Can I fetch an empty category-product link template?
      instructions:
      - text: Fetch the default category related product template.
      - text: Show the starting values for a new category-product link.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/categoryrelatedproducts/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete category related products
      effect: destructive
      questions:
      - Can I remove many category-product links at once?
      - How do I bulk delete category related products by ID?
      instructions:
      - text: Bulk delete category related products {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these category-product links together: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/categoryrelatedproducts({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a category product link
      effect: read
      questions:
      - Can I read a custom property stored on a category related product?
      - What extra custom values does a category-product link carry?
      instructions:
      - text: Get custom property {custompropertyKey} on category related product {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show category-product link {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'