Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Images API

7 actions 7 updates phrasing extends openapi/shopify-images-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/products/{product_id}.json'].put
$.paths['/admin/api/2020-04/products/{product_id}.json'].put
$.paths['/admin/api/2020-07/products/{product_id}.json'].put
$.paths['/admin/api/2020-10/products/{product_id}.json'].put
$.paths['/admin/api/2021-01/products/{product_id}.json'].put
$.paths['/admin/api/unstable/products/{product_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 Images API
  version: 1.0.0
extends: openapi/shopify-images-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/products/{product_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a product, its variants and images (2020-01)
      effect: write
      questions:
      - How do I update a product along with its variants and images on API 2020-01?
      - Can one January 2020 product update change the product's images too?
      instructions:
      - text: Update product {product_id} and its variants and images via 2020-01.
        slots:
          product_id: path.product_id
      - text: Save changes to product {product_id} using the January 2020 release.
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/products/{product_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a product, its variants and images (2020-04)
      effect: write
      questions:
      - Which April 2020 call edits a product together with its variants?
      - Is the 2020-04 product update a PUT on the product ID?
      instructions:
      - text: Edit product {product_id}, including images and variants, on 2020-04.
        slots:
          product_id: path.product_id
      - text: 'April 2020 API: apply my updates to product {product_id}.'
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/products/{product_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a product, its variants and images (2020-07)
      effect: write
      questions:
      - Where do I change a product's details and images on the July 2020 API?
      - Can the 2020-07 product update touch variants in the same call?
      instructions:
      - text: Modify product {product_id} with version 2020-07.
        slots:
          product_id: path.product_id
      - text: Using July 2020, update the images and variants of product {product_id}.
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/products/{product_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a product, its variants and images (2020-10)
      effect: write
      questions:
      - What's the current 2020-10 way to update a product and its images?
      - Does the October 2020 product update also cover variants?
      instructions:
      - text: Update product {product_id} on API 2020-10.
        slots:
          product_id: path.product_id
      - text: 'October 2020 release: change the variants and images on product {product_id}.'
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/products/{product_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a product, its variants and images (2021-01)
      effect: write
      questions:
      - How can I revise a product with its variants and images on the 2021-01 release?
      - Will a January 2021 product update replace images as well?
      instructions:
      - text: Revise product {product_id} via 2021-01.
        slots:
          product_id: path.product_id
      - text: 'January 2021 API: push new images and variant changes to product {product_id}.'
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/products/{product_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a product, its variants and images (unstable)
      effect: write
      questions:
      - Can I update a product and its images through the unstable Admin API?
      - Does the unstable product update also change variants?
      instructions:
      - text: Update product {product_id} on the unstable channel.
        slots:
          product_id: path.product_id
      - text: Via unstable, change product {product_id}'s variants and images.
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-09-24'