Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Admin REST Product Images API

7 actions 7 updates phrasing extends openapi/shopify-product-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['/products/{product_id}/images.json'].get
$.paths['/products/{product_id}/images.json'].post
$.paths['/products/{product_id}/images/count.json'].get
$.paths['/products/{product_id}/images/{image_id}.json'].get
$.paths['/products/{product_id}/images/{image_id}.json'].put
$.paths['/products/{product_id}/images/{image_id}.json'].delete

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 REST Product Images API
  version: 1.0.0
extends: openapi/shopify-product-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['/products/{product_id}/images.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a product's images
      effect: read
      questions:
      - Which photos are attached to one of my products?
      - Can I list a product's images but return only certain fields?
      instructions:
      - text: List all images for product {product_id}.
        slots:
          product_id: path.product_id
      - text: Show product {product_id}'s images after image ID {since_id}.
        slots:
          product_id: path.product_id
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/products/{product_id}/images.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an image to a product
      effect: write
      questions:
      - How do I upload a new photo to a product?
      - Can I add a product image from a URL instead of uploading the file?
      - Is a base64-encoded attachment accepted when adding a product image?
      instructions:
      - text: Add image {image} to product {product_id}.
        slots:
          image: requestBody.image
          product_id: path.product_id
      - text: Attach a new picture {image} to product {product_id} from its URL.
        slots:
          image: requestBody.image
          product_id: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/products/{product_id}/images/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a product's images
      effect: read
      questions:
      - How many images does a given product have?
      - Can I check a product's image total without downloading the images?
      instructions:
      - text: Count the images on product {product_id}.
        slots:
          product_id: path.product_id
      - text: Tell me how many photos product {product_id} has.
        slots:
          product_id: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/products/{product_id}/images/{image_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product image
      effect: read
      questions:
      - What alt text and position does a specific product image have?
      - Can I fetch one image of a product by its image ID?
      instructions:
      - text: Get image {image_id} of product {product_id}.
        slots:
          image_id: path.image_id
          product_id: path.product_id
      - text: Show the details of product {product_id}'s image {image_id}.
        slots:
          product_id: path.product_id
          image_id: path.image_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/products/{product_id}/images/{image_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a product image's alt text or position
      effect: write
      questions:
      - Can I change the alt text on an existing product photo for accessibility?
      - Is it possible to reorder a product's images or link one to specific variants?
      instructions:
      - text: Update image {image_id} on product {product_id} with {image}.
        slots:
          image_id: path.image_id
          product_id: path.product_id
          image: requestBody.image
      - text: Change the position, alt text or variants of product {product_id}'s image {image_id} to {image}.
        slots:
          product_id: path.product_id
          image_id: path.image_id
          image: requestBody.image
      method: generated
      generated: '2026-09-24'
- target: $.paths['/products/{product_id}/images/{image_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a product image
      effect: destructive
      questions:
      - How can I remove an outdated photo from a product?
      - Does deleting a product image affect the product itself?
      instructions:
      - text: Delete image {image_id} from product {product_id}.
        slots:
          image_id: path.image_id
          product_id: path.product_id
      - text: Remove product {product_id}'s photo {image_id}.
        slots:
          product_id: path.product_id
          image_id: path.image_id
      method: generated
      generated: '2026-09-24'