Shopify · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Shopify Assets API
19 actions
19 updates
phrasing
extends
openapi/shopify-assets-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.
What the actions change
x-apievangelist-phrasing
Targets 19 · first 16 shown; the file carries all of them
$.info
$.paths['/admin/api/2020-01/themes/{theme_id}/assets.json'].get
$.paths['/admin/api/2020-01/themes/{theme_id}/assets.json'].put
$.paths['/admin/api/2020-01/themes/{theme_id}/assets.json'].delete
$.paths['/admin/api/2020-04/themes/{theme_id}/assets.json'].get
$.paths['/admin/api/2020-04/themes/{theme_id}/assets.json'].put
$.paths['/admin/api/2020-04/themes/{theme_id}/assets.json'].delete
$.paths['/admin/api/2020-07/themes/{theme_id}/assets.json'].get
$.paths['/admin/api/2020-07/themes/{theme_id}/assets.json'].put
$.paths['/admin/api/2020-07/themes/{theme_id}/assets.json'].delete
$.paths['/admin/api/2020-10/themes/{theme_id}/assets.json'].get
$.paths['/admin/api/2020-10/themes/{theme_id}/assets.json'].put
$.paths['/admin/api/2020-10/themes/{theme_id}/assets.json'].delete
$.paths['/admin/api/2021-01/themes/{theme_id}/assets.json'].get
$.paths['/admin/api/2021-01/themes/{theme_id}/assets.json'].put
$.paths['/admin/api/2021-01/themes/{theme_id}/assets.json'].delete
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Shopify Assets API
version: 1.0.0
extends: openapi/shopify-assets-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: 18
- target: $.paths['/admin/api/2020-01/themes/{theme_id}/assets.json'].get
update:
x-apievangelist-phrasing:
intent: Read one theme file by its key (API 2020-01)
effect: read
questions:
- How can I read the contents of a single Liquid template in my theme on API 2020-01?
- Can I fetch just certain attributes of a theme asset with 2020-01?
instructions:
- text: Get asset {key} from theme {theme} using 2020-01.
slots:
key: query.asset[key]
theme: path.theme_id
- text: Show only {fields} of theme {theme} file {key}, version 2020-01.
slots:
fields: query.fields
theme: path.theme_id
key: query.asset[key]
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/themes/{theme_id}/assets.json'].put
update:
x-apievangelist-phrasing:
intent: Create or update a theme file (API 2020-01)
effect: write
questions:
- Can I upload an image into my theme from a URL with release 2020-01?
- What's the way to copy an existing theme file to a new one on 2020-01?
instructions:
- text: Upload the image at {src} into theme {theme}, API 2020-01.
slots:
src: query.src
theme: path.theme_id
- text: Duplicate theme file {source_key} within theme {theme} via 2020-01.
slots:
source_key: query.source_key
theme: path.theme_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/themes/{theme_id}/assets.json'].delete
update:
x-apievangelist-phrasing:
intent: Delete a file from a theme (API 2020-01)
effect: destructive
questions:
- How do I remove an unused snippet from a theme with API 2020-01?
- Is deleting a theme asset on version 2020-01 permanent?
instructions:
- text: Delete asset {key} from theme {theme} on 2020-01.
slots:
key: query.asset[key]
theme: path.theme_id
- text: Remove file {key} from my theme {theme}, release 2020-01.
slots:
key: query.asset[key]
theme: path.theme_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/themes/{theme_id}/assets.json'].get
update:
x-apievangelist-phrasing:
intent: Read one theme file by its key (API 2020-04)
effect: read
questions:
- What's inside a specific stylesheet or template of my theme, read through 2020-04?
- Is field filtering supported when pulling a theme asset on release 2020-04?
instructions:
- text: Fetch theme file {key} of theme {theme} via release 2020-04.
slots:
key: query.asset[key]
theme: path.theme_id
- text: Read {key} in theme {theme} returning just {fields}, 2020-04.
slots:
key: query.asset[key]
theme: path.theme_id
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/themes/{theme_id}/assets.json'].put
update:
x-apievangelist-phrasing:
intent: Create or update a theme file (API 2020-04)
effect: write
questions:
- Which 2020-04 call adds or overwrites a file in a theme?
- Can I clone one theme asset under a new key using version 2020-04?
instructions:
- text: Add an image from {src} to theme {theme} with 2020-04.
slots:
src: query.src
theme: path.theme_id
- text: Copy asset {source_key} to a new key in theme {theme}, API 2020-04.
slots:
source_key: query.source_key
theme: path.theme_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/themes/{theme_id}/assets.json'].delete
update:
x-apievangelist-phrasing:
intent: Delete a file from a theme (API 2020-04)
effect: destructive
questions:
- Can I delete a leftover template from my theme through version 2020-04?
- What happens when I erase a theme asset by key on 2020-04?
instructions:
- text: Erase theme file {key} from theme {theme} using version 2020-04.
slots:
key: query.asset[key]
theme: path.theme_id
- text: Drop asset {key} out of theme {theme} via 2020-04.
slots:
key: query.asset[key]
theme: path.theme_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/themes/{theme_id}/assets.json'].get
update:
x-apievangelist-phrasing:
intent: Read one theme file by its key (API 2020-07)
effect: read
questions:
- Where do I get the source of one theme template using 2020-07?
- Can version 2020-07 return a theme file with only a subset of fields?
instructions:
- text: Retrieve {key} from theme {theme} on API 2020-07.
slots:
key: query.asset[key]
theme: path.theme_id
- text: Open theme {theme} asset {key} showing {fields} only, 2020-07.
slots:
theme: path.theme_id
key: query.asset[key]
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/themes/{theme_id}/assets.json'].put
update:
x-apievangelist-phrasing:
intent: Create or update a theme file (API 2020-07)
effect: write
questions:
- Is there a 2020-07 endpoint to write a new asset into a theme?
- Can I pull a remote image into theme files on API 2020-07?
instructions:
- text: Save the image from {src} as a file in theme {theme}, 2020-07.
slots:
src: query.src
theme: path.theme_id
- text: Make a copy of theme asset {source_key} in theme {theme} on 2020-07.
slots:
source_key: query.source_key
theme: path.theme_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/themes/{theme_id}/assets.json'].delete
update:
x-apievangelist-phrasing:
intent: Delete a file from a theme (API 2020-07)
effect: destructive
questions:
- Which 2020-07 call removes a single file from a theme?
- Can I clean obsolete assets out of a theme with version 2020-07?
instructions:
- text: Delete theme {theme} file {key} with API 2020-07.
slots:
theme: path.theme_id
key: query.asset[key]
- text: Get rid of asset {key} in theme {theme}, release 2020-07.
slots:
key: query.asset[key]
theme: path.theme_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/themes/{theme_id}/assets.json'].get
update:
x-apievangelist-phrasing:
intent: Read one theme file by its key (API 2020-10)
effect: read
questions:
- How do I download one asset from a theme by its key on 2020-10?
- Which fields of a theme asset can I limit the 2020-10 response to?
instructions:
- text: Show me theme asset {key} in theme {theme}, API 2020-10.
slots:
key: query.asset[key]
theme: path.theme_id
- text: Look up {key} in theme {theme} with just {fields} on 2020-10.
slots:
key: query.asset[key]
theme: path.theme_id
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/themes/{theme_id}/assets.json'].put
update:
x-apievangelist-phrasing:
intent: Create or update a theme file (API 2020-10)
effect: write
questions:
- What's the 2020-10 way to create or overwrite a file inside a theme?
- Can I import an image by URL straight into a theme on version 2020-10?
instructions:
- text: Import the image {src} into theme {theme} via 2020-10.
slots:
src: query.src
theme: path.theme_id
- text: Create a duplicate of asset {source_key} in theme {theme}, version 2020-10.
slots:
source_key: query.source_key
theme: path.theme_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/themes/{theme_id}/assets.json'].delete
update:
x-apievangelist-phrasing:
intent: Delete a file from a theme (API 2020-10)
effect: destructive
questions:
- How can I permanently remove one asset from a theme on 2020-10?
- Does 2020-10 let me delete a theme file identified by its key?
instructions:
- text: Delete file {key} from theme {theme} through 2020-10.
slots:
key: query.asset[key]
theme: path.theme_id
- text: Remove the {key} asset in theme {theme} using API 2020-10.
slots:
key: query.asset[key]
theme: path.theme_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/themes/{theme_id}/assets.json'].get
update:
x-apievangelist-phrasing:
intent: Read one theme file by its key (API 2021-01)
effect: read
questions:
- Can I view a single theme file's value through release 2021-01?
- What does 2021-01 return when I request a theme asset with selected fields?
instructions:
- text: Pull asset {key} of theme {theme} with version 2021-01.
slots:
key: query.asset[key]
theme: path.theme_id
- text: Fetch {fields} for theme {theme} file {key}, 2021-01.
slots:
fields: query.fields
theme: path.theme_id
key: query.asset[key]
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/themes/{theme_id}/assets.json'].put
update:
x-apievangelist-phrasing:
intent: Create or update a theme file (API 2021-01)
effect: write
questions:
- How would I overwrite a template in my theme with API 2021-01?
- Is copying an existing theme asset supported on release 2021-01?
instructions:
- text: Put the image from {src} into theme {theme}, 2021-01.
slots:
src: query.src
theme: path.theme_id
- text: Clone theme file {source_key} inside theme {theme} with 2021-01.
slots:
source_key: query.source_key
theme: path.theme_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/themes/{theme_id}/assets.json'].delete
update:
x-apievangelist-phrasing:
intent: Delete a file from a theme (API 2021-01)
effect: destructive
questions:
- Can I remove one file from a theme via version 2021-01?
- What 2021-01 request deletes a theme asset by key?
instructions:
- text: Delete {key} from theme {theme} on release 2021-01.
slots:
key: query.asset[key]
theme: path.theme_id
- text: Wipe the theme file {key} from theme {theme}, version 2021-01.
slots:
key: query.asset[key]
theme: path.theme_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/themes/{theme_id}/assets.json'].get
update:
x-apievangelist-phrasing:
intent: Read one theme file by its key (unstable API)
effect: read
questions:
- Can I read a single theme asset through the unstable API version?
- Does the unstable release support field selection on a theme file?
instructions:
- text: Get theme {theme} file {key} from the unstable API.
slots:
theme: path.theme_id
key: query.asset[key]
- text: Return {fields} of asset {key} in theme {theme}, unstable version.
slots:
fields: query.fields
key: query.asset[key]
theme: path.theme_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/themes/{theme_id}/assets.json'].put
update:
x-apievangelist-phrasing:
intent: Create or update a theme file (unstable API)
effect: write
questions:
- Is writing a new file into a theme available on the unstable release?
- Can the unstable API upload an image into a theme from a link?
instructions:
- text: Upload {src} as an image asset in theme {theme} via the unstable API.
slots:
src: query.src
theme: path.theme_id
- text: Duplicate {source_key} in theme {theme} on the unstable version.
slots:
source_key: query.source_key
theme: path.theme_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/themes/{theme_id}/assets.json'].delete
update:
x-apievangelist-phrasing:
intent: Delete a file from a theme (unstable API)
effect: destructive
questions:
- How do I delete a theme file using the unstable API?
- Can a theme asset be removed by key on the unstable release?
instructions:
- text: Delete theme asset {key} from theme {theme} with the unstable API.
slots:
key: query.asset[key]
theme: path.theme_id
- text: Strip file {key} out of theme {theme}, unstable release.
slots:
key: query.asset[key]
theme: path.theme_id
method: generated
generated: '2026-09-24'