Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Configuration API

7 actions 7 updates phrasing extends openapi/shopify-configuration-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/shop.json'].get

$.paths['/admin/api/2020-04/shop.json'].get

$.paths['/admin/api/2020-07/shop.json'].get

$.paths['/admin/api/2020-10/shop.json'].get

$.paths['/admin/api/2021-01/shop.json'].get

$.paths['/admin/api/unstable/shop.json'].get

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 Configuration API
  version: 1.0.0
extends: openapi/shopify-configuration-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/shop.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get shop configuration (API 2020-01)
      effect: read
      questions:
      - What store settings does the 2020-01 API return for my shop?
      - Can I read just a few shop configuration fields with version 2020-01?
      instructions:
      - text: Get my shop's configuration using API 2020-01.
      - text: Show shop fields {fields} from version 2020-01.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/shop.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get shop configuration (API 2020-04)
      effect: read
      questions:
      - Where can I read my store's configuration with the 2020-04 API?
      - Is there a 2020-04 call that returns my shop's settings?
      instructions:
      - text: Retrieve shop configuration through the 2020-04 endpoint.
      - text: Fetch only {fields} of my shop settings via API 2020-04.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/shop.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get shop configuration (API 2020-07)
      effect: read
      questions:
      - Can I look up my shop's settings with API 2020-07?
      - Which shop configuration details does version 2020-07 expose?
      instructions:
      - text: Get shop settings via API version 2020-07.
      - text: Return {fields} from my store configuration on 2020-07.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/shop.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get shop configuration (API 2020-10)
      effect: read
      questions:
      - What does my Shopify store's configuration look like on API 2020-10?
      - Can I pull selected shop settings in one 2020-10 call?
      instructions:
      - text: Get my shop's configuration using API version 2020-10.
      - text: Show the 2020-10 shop record with only {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/shop.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get shop configuration (API 2021-01)
      effect: read
      questions:
      - Does the 2021-01 API return my shop's configuration?
      - Which store settings are available under version 2021-01?
      instructions:
      - text: Retrieve my shop settings with the 2021-01 API.
      - text: Give me shop configuration fields {fields} from 2021-01.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/shop.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get shop configuration (unstable API)
      effect: read
      questions:
      - Can I read my shop's configuration on the unstable API version?
      - What does the unstable shop endpoint return?
      instructions:
      - text: Get shop configuration on the unstable API version.
      - text: Fetch shop {fields} from the unstable endpoint.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'