Showpad · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Showpad Themes API

3 actions 3 updates phrasing extends openapi/showpad-themes-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 3

$.info

$.paths['/themes'].get

$.paths['/themes/{themeId}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Showpad Themes API
  version: 1.0.0
extends: openapi/showpad-themes-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/themes'].get
  update:
    x-apievangelist-phrasing:
      intent: List themes
      effect: read
      questions:
      - Which branding themes are available in our Showpad instance?
      - Can I list only a division's themes or find the default one?
      instructions:
      - text: List themes for division {divisionId}, including global ones ({includeGlobal}).
        slots:
          divisionId: query.divisionId
          includeGlobal: query.includeGlobal
      - text: Find themes titled {title}.
        slots:
          title: query.title
      method: generated
      generated: '2026-10-01'
- target: $.paths['/themes/{themeId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a theme's full configuration
      effect: read
      questions:
      - What colors and visual assets does a particular theme use?
      - How do I fetch the complete branding configuration of one theme?
      instructions:
      - text: Show the full configuration of theme {themeId}.
        slots:
          themeId: path.themeId
      - text: Get the color settings and visual assets of theme {themeId}.
        slots:
          themeId: path.themeId
      method: generated
      generated: '2026-10-02'