Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Admin API

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

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 Admin API
  version: 1.0.0
extends: openapi/shopify-admin-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/{metafield_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a metafield (API 2020-01)
      effect: write
      questions:
      - How do I change an existing metafield using the 2020-01 Admin API?
      - Can I edit a custom metafield I already stored, on API version 2020-01?
      instructions:
      - text: Update metafield {metafield_id} via the 2020-01 API.
        slots:
          metafield_id: path.metafield_id
      - text: Using version 2020-01, edit the stored custom metafield {metafield_id}.
        slots:
          metafield_id: path.metafield_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/metafields/{metafield_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a metafield (API 2020-04)
      effect: write
      questions:
      - Which April 2020 (2020-04) endpoint modifies a metafield that already exists?
      - Is changing metafield data supported in the 2020-04 release?
      instructions:
      - text: On the 2020-04 release, modify metafield {metafield_id}.
        slots:
          metafield_id: path.metafield_id
      - text: Change the data held in metafield {metafield_id} with the April 2020 endpoint.
        slots:
          metafield_id: path.metafield_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/metafields/{metafield_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a metafield (API 2020-07)
      effect: write
      questions:
      - My integration targets 2020-07; what updates a metafield there?
      - Can the July 2020 Admin API overwrite extra data I attached as a metafield?
      instructions:
      - text: Overwrite metafield {metafield_id} using July 2020 (2020-07).
        slots:
          metafield_id: path.metafield_id
      - text: With API 2020-07, save changes to metafield {metafield_id}.
        slots:
          metafield_id: path.metafield_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/metafields/{metafield_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a metafield (API 2020-10)
      effect: write
      questions:
      - What is the 2020-10 call for revising a metafield?
      - Does the October 2020 Admin API let me correct a metafield value?
      instructions:
      - text: Correct metafield {metafield_id} on the October 2020 version.
        slots:
          metafield_id: path.metafield_id
      - text: Revise the 2020-10 metafield {metafield_id}.
        slots:
          metafield_id: path.metafield_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/metafields/{metafield_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a metafield (API 2021-01)
      effect: write
      questions:
      - Under the 2021-01 Admin API, where do I update a metafield?
      - Can I amend a metafield with the January 2021 API version?
      instructions:
      - text: Amend metafield {metafield_id} through API version 2021-01.
        slots:
          metafield_id: path.metafield_id
      - text: Push an update for metafield {metafield_id} against January 2021.
        slots:
          metafield_id: path.metafield_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/metafields/{metafield_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a metafield (unstable API)
      effect: write
      questions:
      - Is there an unstable-channel endpoint for updating a metafield?
      - Can I test metafield edits against the unstable Admin API version?
      instructions:
      - text: Update metafield {metafield_id} on the unstable API.
        slots:
          metafield_id: path.metafield_id
      - text: Against the unstable version, test editing metafield {metafield_id}.
        slots:
          metafield_id: path.metafield_id
      method: generated
      generated: '2026-09-24'