Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Approves API

2 actions 2 updates phrasing extends openapi/shopify-approves-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 2

$.info
$.paths['/admin/api/2020-01/comments/{comment_id}/approve.json'].post

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 Approves API
  version: 1.0.0
extends: openapi/shopify-approves-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: 1
- target: $.paths['/admin/api/2020-01/comments/{comment_id}/approve.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Approve a blog comment (API 2020-01)
      effect: write
      questions:
      - How can I approve a pending blog comment on my online store with the 2020-01 API?
      - Can an app publish a comment that is waiting for moderation?
      instructions:
      - text: Approve comment {comment_id} so it shows on the blog.
        slots:
          comment_id: path.comment_id
      - text: Using API version 2020-01, mark blog comment {comment_id} as approved.
        slots:
          comment_id: path.comment_id
      method: generated
      generated: '2026-09-24'