Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Countries API

7 actions 7 updates phrasing extends openapi/shopify-countries-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/countries.json'].get
$.paths['/admin/api/2020-04/countries.json'].get
$.paths['/admin/api/2020-07/countries.json'].get
$.paths['/admin/api/2020-10/countries.json'].get
$.paths['/admin/api/2021-01/countries.json'].get
$.paths['/admin/api/unstable/countries.json'].get

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 Countries API
  version: 1.0.0
extends: openapi/shopify-countries-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/countries.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List the store's shipping countries (API 2020-01)
      effect: read
      questions:
      - Which countries has my store set up for shipping and tax, using API 2020-01?
      - Can the 2020-01 countries list skip ahead past a given country ID?
      instructions:
      - text: List every country configured in my store on version 2020-01.
      - text: Show countries after ID {since_id} with API 2020-01.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/countries.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List the store's shipping countries (API 2020-04)
      effect: read
      questions:
      - What countries are in my shop's settings when I call release 2020-04?
      - Is it possible to trim the 2020-04 country list down to a few fields?
      instructions:
      - text: Pull my store's countries through the 2020-04 release.
      - text: Return only {fields} for each store country, release 2020-04.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/countries.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List the store's shipping countries (API 2020-07)
      effect: read
      questions:
      - Where can my shop ship to, according to the 2020-07 countries endpoint?
      - Does version 2020-07 let me page through countries by ID?
      instructions:
      - text: Get the configured countries for my shop via 2020-07.
      - text: Fetch 2020-07 countries whose IDs come after {since_id}.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/countries.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List the store's shipping countries (API 2020-10)
      effect: read
      questions:
      - How do I see all the countries my store has tax and shipping settings for on 2020-10?
      - Which fields can I ask for when listing store countries in 2020-10?
      instructions:
      - text: Show the countries my store is set up for, API version 2020-10.
      - text: List store countries on 2020-10 including just {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/countries.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List the store's shipping countries (API 2021-01)
      effect: read
      questions:
      - What does the 2021-01 API report as my shop's configured countries?
      - Can I resume a 2021-01 country listing from a known country ID?
      instructions:
      - text: Retrieve my shop's country list using the 2021-01 version.
      - text: Continue the 2021-01 country listing from ID {since_id}.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/countries.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List the store's shipping countries (unstable API)
      effect: read
      questions:
      - Which countries does the unstable Shopify API return for my store?
      - Is field selection supported on the unstable countries listing?
      instructions:
      - text: Read my store's countries from the unstable API version.
      - text: Give me {fields} for my countries from the unstable release.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'