Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Belong API

7 actions 7 updates phrasing extends openapi/shopify-belong-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Shopify's API. It is a proposal applied on top of the contract, not a document Shopify publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/admin/api/2020-01/metafields.json'].get
$.paths['/admin/api/2020-04/metafields.json'].get
$.paths['/admin/api/2020-07/metafields.json'].get
$.paths['/admin/api/2020-10/metafields.json'].get
$.paths['/admin/api/2021-01/metafields.json'].get
$.paths['/admin/api/unstable/metafields.json'].get

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 Shopify Belong API
  version: 1.0.0
extends: openapi/shopify-belong-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/metafields.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List metafields attached to a resource (2020-01)
      effect: read
      questions:
      - How do I list the metafields on a product image with the 2020-01 API?
      - Can version 2020-01 filter metafields by owner resource and owner ID?
      instructions:
      - text: List metafields owned by {owner_resource} {owner_id} using 2020-01.
        slots:
          owner_id: query.metafield[owner_id]
          owner_resource: query.metafield[owner_resource]
      - text: On 2020-01, show custom fields attached to product image {owner_id} ({owner_resource}).
        slots:
          owner_id: query.metafield[owner_id]
          owner_resource: query.metafield[owner_resource]
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/metafields.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List metafields attached to a resource (2020-04)
      effect: read
      questions:
      - Can I read extra data stored on a product image using release 2020-04?
      - Which owner filters does the 2020-04 metafield list accept?
      instructions:
      - text: Get the metafields belonging to {owner_resource} with ID {owner_id} via 2020-04.
        slots:
          owner_id: query.metafield[owner_id]
          owner_resource: query.metafield[owner_resource]
      - text: Using 2020-04, read all metafields on image {owner_id} of type {owner_resource}.
        slots:
          owner_id: query.metafield[owner_id]
          owner_resource: query.metafield[owner_resource]
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/metafields.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List metafields attached to a resource (2020-07)
      effect: read
      questions:
      - Is there a 2020-07 endpoint to list metafields for a given owner?
      - Can I pull custom data metafields from a product image on 2020-07?
      instructions:
      - text: Retrieve metafields for owner {owner_id} of resource {owner_resource} through API version 2020-07.
        slots:
          owner_id: query.metafield[owner_id]
          owner_resource: query.metafield[owner_resource]
      - text: Pull custom data metafields off {owner_resource} {owner_id} on 2020-07.
        slots:
          owner_id: query.metafield[owner_id]
          owner_resource: query.metafield[owner_resource]
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/metafields.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List metafields attached to a resource
      effect: read
      questions:
      - What call lists a resource's metafields in the 2020-10 Admin API?
      - Can I see every metafield that belongs to one product image on version 2020-10?
      instructions:
      - text: List metafields for {owner_resource} {owner_id} with the 2020-10 Admin API.
        slots:
          owner_id: query.metafield[owner_id]
          owner_resource: query.metafield[owner_resource]
      - text: Using 2020-10, show every metafield belonging to product image {owner_id}, owner type {owner_resource}.
        slots:
          owner_id: query.metafield[owner_id]
          owner_resource: query.metafield[owner_resource]
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/metafields.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List metafields attached to a resource (2021-01)
      effect: read
      questions:
      - Does the January 2021 (2021-01) API let me list metafields by owner?
      - Can I export a product image's metafields on 2021-01?
      instructions:
      - text: Export metafields of {owner_resource} {owner_id} via the 2021-01 version.
        slots:
          owner_id: query.metafield[owner_id]
          owner_resource: query.metafield[owner_resource]
      - text: With API version 2021-01, fetch the metafields tied to owner {owner_id} ({owner_resource}).
        slots:
          owner_id: query.metafield[owner_id]
          owner_resource: query.metafield[owner_resource]
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/metafields.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List metafields attached to a resource (unstable)
      effect: read
      questions:
      - Can I list metafields through the unstable Admin API?
      - Does the unstable version filter metafields by their owner?
      instructions:
      - text: Get metafields for {owner_resource} {owner_id} against the unstable API.
        slots:
          owner_id: query.metafield[owner_id]
          owner_resource: query.metafield[owner_resource]
      - text: Use the unstable endpoint to list custom fields owned by {owner_id} of kind {owner_resource}.
        slots:
          owner_id: query.metafield[owner_id]
          owner_resource: query.metafield[owner_resource]
      method: generated
      generated: '2026-09-24'