Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Resource API

7 actions 7 updates phrasing extends openapi/shopify-resource-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'].post
$.paths['/admin/api/2020-04/metafields.json'].post
$.paths['/admin/api/2020-07/metafields.json'].post
$.paths['/admin/api/2020-10/metafields.json'].post
$.paths['/admin/api/2021-01/metafields.json'].post
$.paths['/admin/api/unstable/metafields.json'].post

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 Resource API
  version: 1.0.0
extends: openapi/shopify-resource-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'].post
  update:
    x-apievangelist-phrasing:
      intent: Attach a metafield to a resource (2020-01)
      effect: write
      questions:
      - How do I store custom data on a store resource as a metafield with API version 2020-01?
      - Can my app add a new metafield through the 2020-01 version?
      instructions:
      - text: Create a new metafield using API version 2020-01.
      - text: Attach custom metafield data to a resource on the 2020-01 version.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/metafields.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a metafield (2020-04)
      effect: write
      questions:
      - Which 2020-04 endpoint saves extra custom fields on a resource?
      - Can release 2020-04 create metafields?
      instructions:
      - text: Using release 2020-04, save a metafield on a resource.
      - text: Make a new metafield with the 2020-04 release.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/metafields.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a metafield to a resource (2020-07)
      effect: write
      questions:
      - Does the 2020-07 API let me extend a resource with a metafield?
      - What's involved in adding custom metadata on the 2020-07 API?
      instructions:
      - text: Extend a resource with a new metafield on the 2020-07 API.
      - text: For the 2020-07 API, add a metafield.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/metafields.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a metafield (2020-10, current version)
      effect: write
      questions:
      - What's the way to create a metafield on the current 2020-10 version?
      - Can the non-deprecated 2020-10 API store custom metadata for a resource?
      instructions:
      - text: Create a metafield on 2020-10.
      - text: Save a key-value metafield on a store resource with the non-deprecated 2020-10 API.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/metafields.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a metafield (2021-01)
      effect: write
      questions:
      - Is creating a metafield possible with version 2021-01?
      - Which 2021-01 call adds custom data to a resource?
      instructions:
      - text: With version 2021-01, create a metafield.
      - text: Add custom data to a resource via the 2021-01 version.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/metafields.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a metafield (unstable version)
      effect: write
      questions:
      - Can I test creating a metafield against the unstable API version?
      - What does the unstable version expect when adding a metafield?
      instructions:
      - text: On the unstable API version, create a metafield.
      - text: Try adding a metafield using the unstable version.
      method: generated
      generated: '2026-09-24'