Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Blog API

5 actions 5 updates phrasing extends openapi/shopify-blog-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 5

$.info
$.paths['/admin/api/2020-01/blogs.json'].post
$.paths['/admin/api/2020-01/blogs/{blog_id}.json'].get
$.paths['/admin/api/2020-01/blogs/{blog_id}.json'].put
$.paths['/admin/api/2020-01/blogs/{blog_id}.json'].delete

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 Blog API
  version: 1.0.0
extends: openapi/shopify-blog-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: 4
- target: $.paths['/admin/api/2020-01/blogs.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a new store blog
      effect: write
      questions:
      - How do I start a brand-new blog on my online store with the 2020-01 API?
      - Can I add a second blog alongside my existing one?
      instructions:
      - text: Create a new blog for my online store.
      - text: Set up another blog on the shop using the 2020-01 blogs endpoint.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/blogs/{blog_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blog by ID
      effect: read
      questions:
      - Can I look up a single blog's settings by its ID?
      - Is it possible to return only certain fields when fetching a blog?
      instructions:
      - text: Get blog {blog}.
        slots:
          blog: path.blog_id
      - text: Show only {fields} for blog {blog}.
        slots:
          blog: path.blog_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/blogs/{blog_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a blog
      effect: write
      questions:
      - How can I rename or change the settings of an existing blog?
      - Which call saves changes to a blog I already created?
      instructions:
      - text: Update blog {blog}.
        slots:
          blog: path.blog_id
      - text: Save changes to the existing blog {blog} using API version 2020-01.
        slots:
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/blogs/{blog_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a blog
      effect: destructive
      questions:
      - How do I permanently remove a whole blog from my store?
      - Can I delete a blog I no longer use by its ID?
      instructions:
      - text: Delete blog {blog}.
        slots:
          blog: path.blog_id
      - text: Permanently remove the blog {blog} from the online store.
        slots:
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'