Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Contains API

7 actions 7 updates phrasing extends openapi/shopify-contains-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/themes.json'].post
$.paths['/admin/api/2020-04/themes.json'].post
$.paths['/admin/api/2020-07/themes.json'].post
$.paths['/admin/api/2020-10/themes.json'].post
$.paths['/admin/api/2021-01/themes.json'].post
$.paths['/admin/api/unstable/themes.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 Contains API
  version: 1.0.0
extends: openapi/shopify-contains-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/themes.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a theme from a zip file (2020-01)
      effect: write
      questions:
      - How do I upload a new theme from a zip file URL with the 2020-01 API?
      - Can version 2020-01 install a theme packaged as a public zip?
      instructions:
      - text: Create a new theme from a public zip file using the 2020-01 API.
      - text: On 2020-01, install a theme packaged as a zip.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/themes.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a theme from a zip file (2020-04)
      effect: write
      questions:
      - Can I add a theme to my store from a hosted zip on release 2020-04?
      - Does the 2020-04 theme create need the zip to be publicly reachable?
      instructions:
      - text: Add a theme from a hosted zip archive via 2020-04.
      - text: Using 2020-04, create a theme out of a publicly reachable zip file.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/themes.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a theme from a zip file (2020-07)
      effect: write
      questions:
      - Is there a 2020-07 endpoint for creating a theme?
      - Can I deploy a theme build from a zip through API version 2020-07?
      instructions:
      - text: Deploy a theme build from a zip through API version 2020-07.
      - text: Upload a new store theme on 2020-07.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/themes.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a theme from a zip file
      effect: write
      questions:
      - What call creates a theme in the 2020-10 Admin API?
      - Can I publish a new theme from a zip URL on version 2020-10?
      instructions:
      - text: Create a theme from a zip file with the 2020-10 Admin API.
      - text: Using 2020-10, set up a new theme from a zip package URL.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/themes.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a theme from a zip file (2021-01)
      effect: write
      questions:
      - Does the January 2021 (2021-01) API let me create themes?
      - Can I load a custom theme zip into my store on 2021-01?
      instructions:
      - text: Load a custom theme zip into the store via the 2021-01 version.
      - text: With API version 2021-01, create a theme from a zip.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/themes.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a theme from a zip file (unstable)
      effect: write
      questions:
      - Can I create a theme through the unstable Admin API?
      - Is theme creation from a zip supported on the unstable version?
      instructions:
      - text: Create a theme from a zip against the unstable API.
      - text: Use the unstable endpoint to add a theme packaged as a zip file.
      method: generated
      generated: '2026-09-24'