# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Belonging API
  version: 1.0.0
extends: openapi/shopify-belonging-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/admin/api/2020-01/collections/{collection_id}/products.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List products in a collection (2020-01)
      effect: read
      questions:
      - How do I see which products belong to a collection using the 2020-01 API?
      - Can I cap how many products come back from a collection on 2020-01?
      instructions:
      - text: List the products in collection {collection} using API version 2020-01.
        slots:
          collection: path.collection_id
      - text: Show the first {limit} products of collection {collection} on 2020-01.
        slots:
          collection: path.collection_id
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/collections/{collection_id}/products.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List products in a collection (2020-04)
      effect: read
      questions:
      - Which 2020-04 call returns the products inside a collection?
      - Is there a result limit I can set when listing a collection's items on version 2020-04?
      instructions:
      - text: Get every product that belongs to collection {collection} through the 2020-04 API.
        slots:
          collection: path.collection_id
      - text: Return up to {limit} items from collection {collection} with 2020-04.
        slots:
          collection: path.collection_id
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/collections/{collection_id}/products.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List products in a collection (2020-07)
      effect: read
      questions:
      - What 2020-07 endpoint lists a collection's products?
      - Can I page a collection's product list in smaller batches on 2020-07?
      instructions:
      - text: Show what products are in collection {collection} with version 2020-07.
        slots:
          collection: path.collection_id
      - text: Fetch {limit} products from collection {collection} via the 2020-07 Admin API.
        slots:
          collection: path.collection_id
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/collections/{collection_id}/products.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List products in a collection (2020-10)
      effect: read
      questions:
      - How can I list the products belonging to a collection on the 2020-10 API?
      - Can I limit the number of products returned for a Shopify collection in 2020-10?
      instructions:
      - text: List products belonging to collection {collection} on 2020-10.
        slots:
          collection: path.collection_id
      - text: Give me {limit} products from collection {collection} using the 2020-10 endpoint.
        slots:
          collection: path.collection_id
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/collections/{collection_id}/products.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List products in a collection (2021-01)
      effect: read
      questions:
      - Is there a 2021-01 call to see all products in a collection?
      - Can I restrict the page size of a collection's products in version 2021-01?
      instructions:
      - text: Pull the product list for collection {collection} with the 2021-01 release.
        slots:
          collection: path.collection_id
      - text: Get at most {limit} products in collection {collection} on API version 2021-01.
        slots:
          collection: path.collection_id
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/collections/{collection_id}/products.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List products in a collection (unstable)
      effect: read
      questions:
      - Does the unstable API list the products that belong to a collection?
      - What's the unstable-version call for a collection's product list with a limit?
      instructions:
      - text: List products of collection {collection} using the unstable version.
        slots:
          collection: path.collection_id
      - text: Fetch {limit} products from collection {collection} through the unstable Admin API.
        slots:
          collection: path.collection_id
          limit: query.limit
      method: generated
      generated: '2026-09-24'