Showpad · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Showpad Generic API

2 actions 2 updates phrasing extends openapi/showpad-generic-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 2

$.info
$.paths['/{id}.json'].get

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 Generic API
  version: 1.0.0
extends: openapi/showpad-generic-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: 1
- target: $.paths['/{id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up any resource by its ID
      effect: read
      questions:
      - I have a Showpad ID but don't know what kind of object it is — can I look it up?
      - Is there a single endpoint that resolves any resource ID to its object?
      instructions:
      - text: Look up the resource with ID {id}.
        slots:
          id: path.id
      - text: Figure out what object {id} is and return it.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'