Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify About API

7 actions 7 updates phrasing extends openapi/shopify-about-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/users/current.json'].get
$.paths['/admin/api/2020-04/users/current.json'].get
$.paths['/admin/api/2020-07/users/current.json'].get
$.paths['/admin/api/2020-10/users/current.json'].get
$.paths['/admin/api/2021-01/users/current.json'].get
$.paths['/admin/api/unstable/users/current.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 About API
  version: 1.0.0
extends: openapi/shopify-about-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/users/current.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the staff account behind my token (API 2020-01)
      effect: read
      questions:
      - Which Shopify staff user is my access token acting as, on version 2020-01?
      - Can I check the permissions of the account tied to my token with 2020-01?
      instructions:
      - text: Show the user account linked to my current access token, API 2020-01.
      - text: Look up who I am signed in as through release 2020-01.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/users/current.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the staff account behind my token (API 2020-04)
      effect: read
      questions:
      - Whose account does my current access token belong to under the 2020-04 release?
      - What details about the logged-in staff member does 2020-04 return?
      instructions:
      - text: Fetch the current user's profile via 2020-04.
      - text: Identify the staff member my token represents on version 2020-04.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/users/current.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the staff account behind my token (API 2020-07)
      effect: read
      questions:
      - Is there a way to confirm which admin user an access token maps to in 2020-07?
      - What name and email does 2020-07 show for the account using this token?
      instructions:
      - text: Tell me which account my access token is associated with, 2020-07.
      - text: Get my own staff user record using API 2020-07.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/users/current.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the staff account behind my token (API 2020-10)
      effect: read
      questions:
      - How do I find out which user my online access token is logged in as on 2020-10?
      - Which staff member is making these 2020-10 API calls?
      instructions:
      - text: Retrieve the current user for my token with version 2020-10.
      - text: Show my account details as the 2020-10 API sees them.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/users/current.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the staff account behind my token (API 2021-01)
      effect: read
      questions:
      - What user account is attached to the access token I use with 2021-01?
      - Can the 2021-01 API tell me the current staff member's permissions?
      instructions:
      - text: Return the staff account behind this token, release 2021-01.
      - text: Check who the signed-in user is through 2021-01.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/users/current.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the staff account behind my token (unstable API)
      effect: read
      questions:
      - Which user does the unstable API say owns my access token?
      - Does the unstable version expose the current user's account info?
      instructions:
      - text: Pull the current user's account from the unstable release.
      - text: Find the admin user tied to my token using the unstable version.
      method: generated
      generated: '2026-09-24'