API Evangelist conversational phrasing for Shopify Reports API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Reports API
  version: 1.0.0
extends: openapi/shopify-reports-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: 18
- target: $.paths['/admin/api/2020-01/reports.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom analytics report (2020-01)
      effect: write
      questions:
      - How do I create a custom report from a ShopifyQL query with API version 2020-01?
      - Can I give a new report its own name on the 2020-01 version?
      instructions:
      - text: Create a report named {name} running {shopify_ql} using API version 2020-01.
        slots:
          name: query.name
          shopify_ql: query.shopify_ql
      - text: Add a custom report built on the query {shopify_ql} on the 2020-01 version.
        slots:
          shopify_ql: query.shopify_ql
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/reports/{report_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a report (2020-01)
      effect: write
      questions:
      - Can I change a custom report I already made through API version 2020-01?
      - Which 2020-01 call edits an existing report?
      instructions:
      - text: Update report {report_id} using API version 2020-01.
        slots:
          report_id: path.report_id
      - text: Edit existing report {report_id} on the 2020-01 version.
        slots:
          report_id: path.report_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/reports/{report_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a report (2020-01)
      effect: destructive
      questions:
      - How do I permanently remove a custom report on 2020-01?
      - Can a report be deleted through the 2020-01 API version?
      instructions:
      - text: Delete report {report_id} using API version 2020-01.
        slots:
          report_id: path.report_id
      - text: Remove report {report_id} from the admin on the 2020-01 version.
        slots:
          report_id: path.report_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/reports.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a ShopifyQL report (2020-04)
      effect: write
      questions:
      - Can I save a ShopifyQL query as a named report with the 2020-04 release?
      - Which 2020-04 endpoint creates a new report?
      instructions:
      - text: Using release 2020-04, save {shopify_ql} as a report called {name}.
        slots:
          shopify_ql: query.shopify_ql
          name: query.name
      - text: Make a new report titled {name} with the 2020-04 release.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/reports/{report_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify a report (2020-04)
      effect: write
      questions:
      - Can release 2020-04 modify a report after it is created?
      - What's the 2020-04 call to save changes to a report?
      instructions:
      - text: Modify report {report_id} through release 2020-04.
        slots:
          report_id: path.report_id
      - text: Using release 2020-04, save changes to report {report_id}.
        slots:
          report_id: path.report_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/reports/{report_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a report (2020-04)
      effect: destructive
      questions:
      - Which 2020-04 call deletes a report for good?
      - Can I get rid of an unused report with release 2020-04?
      instructions:
      - text: Get rid of unused report {report_id} with release 2020-04.
        slots:
          report_id: path.report_id
      - text: Using release 2020-04, permanently delete report {report_id}.
        slots:
          report_id: path.report_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/reports.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new report (2020-07)
      effect: write
      questions:
      - Does the 2020-07 API let my app publish a report defined by ShopifyQL?
      - What's involved in creating a report on the 2020-07 API?
      instructions:
      - text: Publish a report named {name} from the ShopifyQL {shopify_ql} on the 2020-07 API.
        slots:
          name: query.name
          shopify_ql: query.shopify_ql
      - text: For the 2020-07 API, create a report called {name}.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/reports/{report_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a report (2020-07)
      effect: write
      questions:
      - Does the 2020-07 API allow editing a report that already exists?
      - Can I adjust a report through 2020-07?
      instructions:
      - text: Apply changes to report {report_id}, API 2020-07.
        slots:
          report_id: path.report_id
      - text: Edit report {report_id} with the 2020-07 API.
        slots:
          report_id: path.report_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/reports/{report_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a report (2020-07)
      effect: destructive
      questions:
      - Is deleting a report supported on the 2020-07 API?
      - How would I clear out an old report on 2020-07?
      instructions:
      - text: Clear out old report {report_id} on the 2020-07 API.
        slots:
          report_id: path.report_id
      - text: Delete report {report_id} (API 2020-07).
        slots:
          report_id: path.report_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/reports.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a report (2020-10, current version)
      effect: write
      questions:
      - What's the way to create a report on the current 2020-10 version?
      - Can the non-deprecated 2020-10 API build a report from a ShopifyQL query?
      instructions:
      - text: Create a report called {name} with query {shopify_ql} on 2020-10.
        slots:
          name: query.name
          shopify_ql: query.shopify_ql
      - text: Build a report from {shopify_ql} using the non-deprecated 2020-10 API.
        slots:
          shopify_ql: query.shopify_ql
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/reports/{report_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a report (2020-10)
      effect: write
      questions:
      - How do I update an existing report with the current 2020-10 version?
      - Can a report be changed via 2020-10?
      instructions:
      - text: Update report {report_id} on 2020-10.
        slots:
          report_id: path.report_id
      - text: Change report {report_id} with the non-deprecated 2020-10 API.
        slots:
          report_id: path.report_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/reports/{report_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a report (2020-10)
      effect: destructive
      questions:
      - Can I delete a report with the non-deprecated 2020-10 API?
      - Which 2020-10 call removes a report?
      instructions:
      - text: Delete report {report_id} on 2020-10.
        slots:
          report_id: path.report_id
      - text: Remove report {report_id} using the current 2020-10 version.
        slots:
          report_id: path.report_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/reports.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a report (2021-01)
      effect: write
      questions:
      - Is creating a report possible with version 2021-01?
      - What's the 2021-01 endpoint for adding a ShopifyQL report?
      instructions:
      - text: With version 2021-01, create a report named {name}.
        slots:
          name: query.name
      - text: Set up a report that runs {shopify_ql} via the 2021-01 version.
        slots:
          shopify_ql: query.shopify_ql
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/reports/{report_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Modify a report (2021-01)
      effect: write
      questions:
      - Can I modify an existing report in version 2021-01?
      - Which 2021-01 call updates a report?
      instructions:
      - text: With version 2021-01, update report {report_id}.
        slots:
          report_id: path.report_id
      - text: Revise report {report_id} through the 2021-01 version.
        slots:
          report_id: path.report_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/reports/{report_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a report (2021-01)
      effect: destructive
      questions:
      - Is it possible to delete a report through version 2021-01?
      - Which 2021-01 endpoint removes a report?
      instructions:
      - text: With version 2021-01, delete report {report_id}.
        slots:
          report_id: path.report_id
      - text: Discard report {report_id} via the 2021-01 version.
        slots:
          report_id: path.report_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/reports.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a report (unstable version)
      effect: write
      questions:
      - Can I test creating a ShopifyQL report against the unstable API version?
      - What does the unstable version expect when adding a report?
      instructions:
      - text: On the unstable API version, create a report named {name} from {shopify_ql}.
        slots:
          name: query.name
          shopify_ql: query.shopify_ql
      - text: Try adding a report called {name} using the unstable version.
        slots:
          name: query.name
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/reports/{report_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a report (unstable version)
      effect: write
      questions:
      - Can I update an existing report against the unstable API version?
      - How does the unstable version handle edits to a report?
      instructions:
      - text: On the unstable API version, update report {report_id}.
        slots:
          report_id: path.report_id
      - text: Try editing report {report_id} using the unstable version.
        slots:
          report_id: path.report_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/reports/{report_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a report (unstable version)
      effect: destructive
      questions:
      - Can I delete a report through the unstable API version?
      - Does the unstable version support removing a report?
      instructions:
      - text: On the unstable API version, delete report {report_id}.
        slots:
          report_id: path.report_id
      - text: Try removing report {report_id} with the unstable version.
        slots:
          report_id: path.report_id
      method: generated
      generated: '2026-09-24'