Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Script API

13 actions 13 updates phrasing extends openapi/shopify-script-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 13

$.info
$.paths['/admin/api/2020-01/script_tags.json'].post
$.paths['/admin/api/2020-01/script_tags/{script_tag_id}.json'].put
$.paths['/admin/api/2020-04/script_tags.json'].post
$.paths['/admin/api/2020-04/script_tags/{script_tag_id}.json'].put
$.paths['/admin/api/2020-07/script_tags.json'].post
$.paths['/admin/api/2020-07/script_tags/{script_tag_id}.json'].put
$.paths['/admin/api/2020-10/script_tags.json'].post
$.paths['/admin/api/2020-10/script_tags/{script_tag_id}.json'].put
$.paths['/admin/api/2021-01/script_tags.json'].post
$.paths['/admin/api/2021-01/script_tags/{script_tag_id}.json'].put
$.paths['/admin/api/unstable/script_tags.json'].post
$.paths['/admin/api/unstable/script_tags/{script_tag_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 Script API
  version: 1.0.0
extends: openapi/shopify-script-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: 12
- target: $.paths['/admin/api/2020-01/script_tags.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a storefront script tag (2020-01)
      effect: write
      questions:
      - How do I load my app's script on the storefront with a script tag, on API 2020-01?
      - Can I create a new script tag through the January 2020 Admin API?
      instructions:
      - text: Create a script tag via 2020-01.
      - text: On January 2020, add a new script tag to the online store.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/script_tags/{script_tag_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a script tag (2020-01)
      effect: write
      questions:
      - How do I change an existing script tag using API 2020-01?
      - Can I update a script tag I already created, in the January 2020 Admin API?
      instructions:
      - text: Update script tag {script_tag} via 2020-01.
        slots:
          script_tag: path.script_tag_id
      - text: On January 2020, modify existing script tag {script_tag}.
        slots:
          script_tag: path.script_tag_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/script_tags.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a storefront script tag (2020-04)
      effect: write
      questions:
      - Which 2020-04 endpoint creates a script tag?
      - In April 2020, can my app add a script tag to the storefront?
      instructions:
      - text: Add a new script tag using 2020-04.
      - text: Using April 2020, register a script tag for the storefront.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/script_tags/{script_tag_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a script tag (2020-04)
      effect: write
      questions:
      - Which 2020-04 endpoint updates a script tag?
      - In April 2020, can I edit a script tag after it's installed?
      instructions:
      - text: Edit script tag {script_tag} using 2020-04.
        slots:
          script_tag: path.script_tag_id
      - text: Using April 2020, update the existing script tag {script_tag}.
        slots:
          script_tag: path.script_tag_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/script_tags.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a storefront script tag (2020-07)
      effect: write
      questions:
      - What call creates a new script tag in the 2020-07 API?
      - Is adding a storefront script tag possible with July 2020?
      instructions:
      - text: Create a new script tag with 2020-07.
      - text: Via July 2020, install a script tag on the storefront.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/script_tags/{script_tag_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a script tag (2020-07)
      effect: write
      questions:
      - What call modifies an existing script tag in the 2020-07 API?
      - Is updating an installed script tag possible with July 2020?
      instructions:
      - text: Modify script tag {script_tag} with 2020-07.
        slots:
          script_tag: path.script_tag_id
      - text: Via July 2020, change script tag {script_tag}.
        slots:
          script_tag: path.script_tag_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/script_tags.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a storefront script tag
      effect: write
      questions:
      - My app needs JavaScript on the storefront; how do I create a script tag on 2020-10?
      - Where in October 2020 do I add a new script tag?
      instructions:
      - text: Create a script tag for the online store (API 2020-10).
      - text: With October 2020, add a new storefront script tag.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/script_tags/{script_tag_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a script tag
      effect: write
      questions:
      - My storefront script tag needs changes; how do I update it on 2020-10?
      - Where in October 2020 do I edit an existing script tag?
      instructions:
      - text: Update existing script tag {script_tag} (API 2020-10).
        slots:
          script_tag: path.script_tag_id
      - text: With October 2020, edit script tag {script_tag}.
        slots:
          script_tag: path.script_tag_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/script_tags.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a storefront script tag (2021-01)
      effect: write
      questions:
      - On 2021-01, how can I create a script tag?
      - Does January 2021 let apps add new script tags?
      instructions:
      - text: Add a script tag using 2021-01.
      - text: Using January 2021, create a new storefront script tag.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/script_tags/{script_tag_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a script tag (2021-01)
      effect: write
      questions:
      - On 2021-01, how can I update a script tag?
      - Does January 2021 let me change a script tag I already created?
      instructions:
      - text: Change script tag {script_tag} using 2021-01.
        slots:
          script_tag: path.script_tag_id
      - text: Using January 2021, update existing script tag {script_tag}.
        slots:
          script_tag: path.script_tag_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/script_tags.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a storefront script tag (unstable)
      effect: write
      questions:
      - Can I create a script tag on the unstable API?
      - Which unstable-version endpoint adds a new script tag?
      instructions:
      - text: Create a new script tag on unstable.
      - text: Using the unstable endpoint, add a script tag to the store.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/script_tags/{script_tag_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a script tag (unstable)
      effect: write
      questions:
      - Can I update a script tag on the unstable API?
      - Which unstable-version endpoint edits an existing script tag?
      instructions:
      - text: Update script tag {script_tag} on unstable.
        slots:
          script_tag: path.script_tag_id
      - text: Using the unstable endpoint, modify existing script tag {script_tag}.
        slots:
          script_tag: path.script_tag_id
      method: generated
      generated: '2026-09-24'