Showpad · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Showpad Tag Categories API

7 actions 7 updates phrasing extends openapi/showpad-tag-categories-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Showpad's API. It is a proposal applied on top of the contract, not a document Showpad publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/tag-categories'].get
$.paths['/tag-categories'].post
$.paths['/tag-categories/{tagCategoryId}'].get
$.paths['/tag-categories/{tagCategoryId}'].post
$.paths['/tag-categories/{tagCategoryId}'].delete
$.paths['/tag-categories/{tagCategoryId}/tags'].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 Showpad Tag Categories API
  version: 1.0.0
extends: openapi/showpad-tag-categories-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/tag-categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List tag categories
      effect: read
      questions:
      - What tag categories are set up in our content library?
      - Can I list only the tag categories of certain divisions?
      instructions:
      - text: List tag categories in divisions {divisionIds}.
        slots:
          divisionIds: query.divisionIds
      - text: Show all tag categories, {limit} at a time.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tag-categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a tag category
      effect: write
      questions:
      - How do I create a new tag category for organizing content?
      - Can I nest a tag category under a parent and attach tags when creating it?
      instructions:
      - text: Create tag category {name} in division {division}.
        slots:
          name: requestBody.name
          division: requestBody.division
      - text: Create tag category {name} in division {division} under parent {parent} with tags {tags}.
        slots:
          name: requestBody.name
          division: requestBody.division
          parent: requestBody.parent
          tags: requestBody.tags
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tag-categories/{tagCategoryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a tag category
      effect: read
      questions:
      - How do I look up one tag category by its ID?
      - What details does a single tag category return?
      instructions:
      - text: Get tag category {tagCategoryId}.
        slots:
          tagCategoryId: path.tagCategoryId
      - text: Show the details of tag category {tagCategoryId}.
        slots:
          tagCategoryId: path.tagCategoryId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tag-categories/{tagCategoryId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a tag category
      effect: write
      questions:
      - How do I rename or publish a tag category?
      - Can I move a tag category under a different parent?
      instructions:
      - text: Rename tag category {tagCategoryId} to {name}.
        slots:
          tagCategoryId: path.tagCategoryId
          name: requestBody.name
      - text: Set tag category {tagCategoryId} published to {isPublished}.
        slots:
          tagCategoryId: path.tagCategoryId
          isPublished: requestBody.isPublished
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tag-categories/{tagCategoryId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a tag category
      effect: destructive
      questions:
      - How do I remove a tag category we no longer use?
      - What call deletes a tag category?
      instructions:
      - text: Delete tag category {tagCategoryId}.
        slots:
          tagCategoryId: path.tagCategoryId
      - text: Remove the tag category with ID {tagCategoryId}.
        slots:
          tagCategoryId: path.tagCategoryId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/tag-categories/{tagCategoryId}/tags'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or remove tags in a tag category
      effect: write
      questions:
      - How do I add tags to or remove tags from an existing category?
      - Can I clear every tag out of a tag category at once?
      instructions:
      - text: Add tags {add} to tag category {tagCategoryId}.
        slots:
          add: requestBody.add
          tagCategoryId: path.tagCategoryId
      - text: Remove tags {remove} from tag category {tagCategoryId}.
        slots:
          remove: requestBody.remove
          tagCategoryId: path.tagCategoryId
      method: generated
      generated: '2026-10-01'