API Evangelist conversational phrasing for Shopify Article 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 Article API
  version: 1.0.0
extends: openapi/shopify-article-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: 26
- target: $.paths['/admin/api/2020-01/blogs/{blog_id}/articles.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a new article to a blog (2020-01)
      effect: write
      questions:
      - Can I post a new article to my store blog with the 2020-01 Admin API?
      - What 2020-01 call adds an article under a specific blog?
      instructions:
      - text: Create an article in blog {blog} using API version 2020-01.
        slots:
          blog: path.blog_id
      - text: Write a new post into blog {blog} through the 2020-01 API.
        slots:
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/blogs/{blog_id}/articles/{article_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blog article (2020-01)
      effect: read
      questions:
      - How do I read one article from a blog with the 2020-01 API?
      - Can the 2020-01 article lookup return only the fields I ask for?
      instructions:
      - text: Get article {article} from blog {blog} using API version 2020-01.
        slots:
          article: path.article_id
          blog: path.blog_id
      - text: Fetch {fields} of article {article} in blog {blog} on 2020-01.
        slots:
          article: path.article_id
          blog: path.blog_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/blogs/{blog_id}/articles/{article_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a blog article (2020-01)
      effect: write
      questions:
      - Can I edit a published blog article with the 2020-01 API?
      - What 2020-01 endpoint saves changes to an existing article?
      instructions:
      - text: Update article {article} in blog {blog} using API version 2020-01.
        slots:
          article: path.article_id
          blog: path.blog_id
      - text: Revise the existing post {article} on blog {blog} with 2020-01.
        slots:
          article: path.article_id
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/blogs/{blog_id}/articles/{article_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a blog article (2020-01)
      effect: destructive
      questions:
      - How do I delete an article from a blog on 2020-01?
      - Can I permanently take down a blog post with the 2020-01 API?
      instructions:
      - text: Delete article {article} from blog {blog} using API version 2020-01.
        slots:
          article: path.article_id
          blog: path.blog_id
      - text: Take down post {article} on blog {blog} permanently via 2020-01.
        slots:
          article: path.article_id
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/blogs/{blog_id}/articles.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a new article to a blog (2020-04)
      effect: write
      questions:
      - Which 2020-04 endpoint creates a blog article?
      - Is posting an article to a particular blog supported on version 2020-04?
      instructions:
      - text: Add a new article to blog {blog} through the 2020-04 API.
        slots:
          blog: path.blog_id
      - text: Publish a post under blog {blog} with version 2020-04.
        slots:
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/blogs/{blog_id}/articles/{article_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blog article (2020-04)
      effect: read
      questions:
      - Which 2020-04 call retrieves a single blog article?
      - Could I pull a post's details by blog and article ID in 2020-04?
      instructions:
      - text: Retrieve article {article} in blog {blog} via the 2020-04 API.
        slots:
          article: path.article_id
          blog: path.blog_id
      - text: Show only {fields} for article {article} of blog {blog} on 2020-04.
        slots:
          article: path.article_id
          blog: path.blog_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/blogs/{blog_id}/articles/{article_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a blog article (2020-04)
      effect: write
      questions:
      - Which 2020-04 call modifies a blog article?
      - Is changing an article I already posted possible on version 2020-04?
      instructions:
      - text: Modify article {article} in blog {blog} through the 2020-04 API.
        slots:
          article: path.article_id
          blog: path.blog_id
      - text: Save edits to post {article} on blog {blog} with 2020-04.
        slots:
          article: path.article_id
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/blogs/{blog_id}/articles/{article_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a blog article (2020-04)
      effect: destructive
      questions:
      - Which 2020-04 call removes an article from a blog?
      - Is there a 2020-04 way to get rid of an old blog post?
      instructions:
      - text: Remove article {article} from blog {blog} through the 2020-04 API.
        slots:
          article: path.article_id
          blog: path.blog_id
      - text: Get rid of post {article} in blog {blog} with 2020-04.
        slots:
          article: path.article_id
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/blogs/{blog_id}/articles.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a new article to a blog (2020-07)
      effect: write
      questions:
      - What 2020-07 endpoint posts an article to a blog?
      - Can I create a blog entry for my shop using version 2020-07?
      instructions:
      - text: Create a blog article in blog {blog} with version 2020-07.
        slots:
          blog: path.blog_id
      - text: Start a new post on blog {blog} via the 2020-07 Admin API.
        slots:
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/blogs/{blog_id}/articles/{article_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blog article (2020-07)
      effect: read
      questions:
      - What 2020-07 endpoint returns one article from a blog?
      - Does version 2020-07 let me trim the fields on an article lookup?
      instructions:
      - text: Look up article {article} in blog {blog} using 2020-07.
        slots:
          article: path.article_id
          blog: path.blog_id
      - text: Return only {fields} of article {article} from blog {blog} on version 2020-07.
        slots:
          article: path.article_id
          blog: path.blog_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/blogs/{blog_id}/articles/{article_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a blog article (2020-07)
      effect: write
      questions:
      - Is updating a blog article possible in 2020-07?
      - What endpoint in 2020-07 edits a post that's already on my blog?
      instructions:
      - text: Edit article {article} in blog {blog} using version 2020-07.
        slots:
          article: path.article_id
          blog: path.blog_id
      - text: Apply changes to post {article} on blog {blog} via the 2020-07 Admin API.
        slots:
          article: path.article_id
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/blogs/{blog_id}/articles/{article_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a blog article (2020-07)
      effect: destructive
      questions:
      - What 2020-07 endpoint deletes a blog article?
      - Can I remove a post from my blog for good using version 2020-07?
      instructions:
      - text: Delete article {article} in blog {blog} via version 2020-07.
        slots:
          article: path.article_id
          blog: path.blog_id
      - text: Wipe out post {article} from blog {blog} using the 2020-07 Admin API.
        slots:
          article: path.article_id
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/blogs/{blog_id}/articles.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a new article to a blog (2020-10)
      effect: write
      questions:
      - How can I publish an article to one of my blogs on 2020-10?
      - Which 2020-10 call writes a new article into a Shopify store blog?
      instructions:
      - text: Create an article in blog {blog} on 2020-10.
        slots:
          blog: path.blog_id
      - text: Post a new entry to blog {blog} using the 2020-10 endpoint.
        slots:
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/blogs/{blog_id}/articles/{article_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blog article (2020-10)
      effect: read
      questions:
      - How can I view a single blog article in version 2020-10?
      - Can I fetch one post by its blog and article IDs from the 2020-10 API?
      instructions:
      - text: Retrieve article {article} from blog {blog} on 2020-10.
        slots:
          article: path.article_id
          blog: path.blog_id
      - text: Get {fields} of article {article} in blog {blog} via version 2020-10.
        slots:
          article: path.article_id
          blog: path.blog_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/blogs/{blog_id}/articles/{article_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a blog article (2020-10)
      effect: write
      questions:
      - What's the 2020-10 call for updating a blog article?
      - Which 2020-10 endpoint rewrites a post already live on my blog?
      instructions:
      - text: Update article {article} in blog {blog} on 2020-10.
        slots:
          article: path.article_id
          blog: path.blog_id
      - text: Change the content of post {article} on blog {blog} via version 2020-10.
        slots:
          article: path.article_id
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/blogs/{blog_id}/articles/{article_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a blog article (2020-10)
      effect: destructive
      questions:
      - How can I delete a blog article on 2020-10?
      - Which 2020-10 call permanently removes a post from a blog?
      instructions:
      - text: Delete article {article} from blog {blog} on 2020-10.
        slots:
          article: path.article_id
          blog: path.blog_id
      - text: Remove post {article} from blog {blog} for good via version 2020-10.
        slots:
          article: path.article_id
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/blogs/{blog_id}/articles.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a new article to a blog (2021-01)
      effect: write
      questions:
      - Can I add a new article to a blog through the 2021-01 API?
      - Where do I create a blog post in version 2021-01?
      instructions:
      - text: Publish an article to blog {blog} with the 2021-01 release.
        slots:
          blog: path.blog_id
      - text: Create a new post in blog {blog} on API version 2021-01.
        slots:
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/blogs/{blog_id}/articles/{article_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blog article (2021-01)
      effect: read
      questions:
      - Is there a 2021-01 call to read one blog article?
      - Can I request specific fields of an article in 2021-01?
      instructions:
      - text: Fetch article {article} of blog {blog} with the 2021-01 release.
        slots:
          article: path.article_id
          blog: path.blog_id
      - text: Pull {fields} from article {article} in blog {blog} using 2021-01.
        slots:
          article: path.article_id
          blog: path.blog_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/blogs/{blog_id}/articles/{article_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a blog article (2021-01)
      effect: write
      questions:
      - Can the 2021-01 API change an existing blog article?
      - Where do I edit a published post in version 2021-01?
      instructions:
      - text: Modify article {article} in blog {blog} with the 2021-01 release.
        slots:
          article: path.article_id
          blog: path.blog_id
      - text: Push edits to post {article} on blog {blog} using 2021-01.
        slots:
          article: path.article_id
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/blogs/{blog_id}/articles/{article_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a blog article (2021-01)
      effect: destructive
      questions:
      - Can the 2021-01 API delete a blog article?
      - Where is the article delete call in 2021-01?
      instructions:
      - text: Remove article {article} from blog {blog} with the 2021-01 release.
        slots:
          article: path.article_id
          blog: path.blog_id
      - text: Delete my post {article} in blog {blog} using 2021-01.
        slots:
          article: path.article_id
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/blogs/{blog_id}/articles.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Publish a new article to a blog (unstable)
      effect: write
      questions:
      - Does the unstable API let me create a blog article?
      - What's the unstable-version call for a new blog post?
      instructions:
      - text: Create an article in blog {blog} using the unstable version.
        slots:
          blog: path.blog_id
      - text: Add a post to blog {blog} through the unstable Admin API.
        slots:
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/blogs/{blog_id}/articles/{article_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blog article (unstable)
      effect: read
      questions:
      - How would I fetch a blog article from the unstable API?
      - Which unstable endpoint returns one post from a blog?
      instructions:
      - text: Get article {article} in blog {blog} from the unstable version.
        slots:
          article: path.article_id
          blog: path.blog_id
      - text: Look up the {fields} on article {article} of blog {blog} with the unstable API.
        slots:
          article: path.article_id
          blog: path.blog_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/blogs/{blog_id}/articles/{article_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a blog article (unstable)
      effect: write
      questions:
      - Does the unstable version support editing a blog article?
      - What's the unstable call for revising a blog post?
      instructions:
      - text: Update article {article} in blog {blog} on the unstable API.
        slots:
          article: path.article_id
          blog: path.blog_id
      - text: Edit the existing post {article} on blog {blog} via the unstable version.
        slots:
          article: path.article_id
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/blogs/{blog_id}/articles/{article_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a blog article (unstable)
      effect: destructive
      questions:
      - Does the unstable version let me delete a blog article?
      - What unstable endpoint removes a blog post?
      instructions:
      - text: Delete article {article} from blog {blog} on the unstable API.
        slots:
          article: path.article_id
          blog: path.blog_id
      - text: Get rid of post {article} in blog {blog} via the unstable version.
        slots:
          article: path.article_id
          blog: path.blog_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/comments.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a comment to an article (2020-01)
      effect: write
      questions:
      - Can I post a comment on a blog article through the 2020-01 API?
      - What 2020-01 endpoint creates a reader comment for an article?
      instructions:
      - text: Add a comment to an article using the 2020-01 comments endpoint.
      - text: Create a new article comment on API version 2020-01.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/comments/{comment_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a comment on an article (2020-01)
      effect: write
      questions:
      - Can I change the text of an existing article comment with the 2020-01 API?
      - Which 2020-01 call updates a comment someone left on a blog post?
      instructions:
      - text: Update comment {comment} using API version 2020-01.
        slots:
          comment: path.comment_id
      - text: Edit the article comment {comment} through the 2020-01 comments endpoint.
        slots:
          comment: path.comment_id
      method: generated
      generated: '2026-09-24'