Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify County API

7 actions 7 updates phrasing extends openapi/shopify-county-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/{country_id}.json'].get
$.paths['/admin/api/2020-04/countries/{country_id}.json'].get
$.paths['/admin/api/2020-07/countries/{country_id}.json'].get
$.paths['/admin/api/2020-10/countries/{country_id}.json'].get
$.paths['/admin/api/2021-01/countries/{country_id}.json'].get
$.paths['/admin/api/unstable/countries/{country_id}.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 County API
  version: 1.0.0
extends: openapi/shopify-county-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/{country_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shipping country (API 2020-01)
      effect: read
      questions:
      - What does API 2020-01 tell me about one country my shop ships to?
      - Can I look up a single country's settings by ID with version 2020-01?
      instructions:
      - text: Get country {country_id} using API 2020-01.
        slots:
          country_id: path.country_id
      - text: Show {fields} for country {country_id} on version 2020-01.
        slots:
          fields: query.fields
          country_id: path.country_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/countries/{country_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shipping country (API 2020-04)
      effect: read
      questions:
      - Can I retrieve one country record from my store with API 2020-04?
      - Which country fields can a 2020-04 lookup be trimmed to?
      instructions:
      - text: Retrieve country {country_id} through the 2020-04 endpoint.
        slots:
          country_id: path.country_id
      - text: Fetch country {country_id} with fields {fields} via API 2020-04.
        slots:
          country_id: path.country_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/countries/{country_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shipping country (API 2020-07)
      effect: read
      questions:
      - What details does version 2020-07 give for a specific country?
      - Can I check one of my shop's countries by ID on API 2020-07?
      instructions:
      - text: Get the country with ID {country_id} on version 2020-07.
        slots:
          country_id: path.country_id
      - text: Return only {fields} of country {country_id} from API 2020-07.
        slots:
          fields: query.fields
          country_id: path.country_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/countries/{country_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shipping country (API 2020-10)
      effect: read
      questions:
      - How do I look up a specific country in my Shopify store with API 2020-10?
      - Can a 2020-10 country lookup return just a few fields?
      instructions:
      - text: Get country {country_id} using API version 2020-10.
        slots:
          country_id: path.country_id
      - text: Show country {country_id} from the 2020-10 endpoint with only {fields}.
        slots:
          country_id: path.country_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/countries/{country_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shipping country (API 2021-01)
      effect: read
      questions:
      - Does version 2021-01 let me fetch one country by ID?
      - What does the 2021-01 API show for a specific country?
      instructions:
      - text: Retrieve country {country_id} with the 2021-01 API.
        slots:
          country_id: path.country_id
      - text: Get 2021-01 details of country {country_id}, fields {fields}.
        slots:
          country_id: path.country_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/countries/{country_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shipping country (unstable API)
      effect: read
      questions:
      - Can I fetch a single country on the unstable API version?
      - What does the unstable API return for one country?
      instructions:
      - text: Get country {country_id} on the unstable version.
        slots:
          country_id: path.country_id
      - text: Fetch unstable-version country {country_id} showing {fields}.
        slots:
          country_id: path.country_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'