Showpad · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Showpad Shares API

2 actions 2 updates phrasing extends openapi/showpad-shares-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['/shares'].post

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 Shares API
  version: 1.0.0
extends: openapi/showpad-shares-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['/shares'].post
  update:
    x-apievangelist-phrasing:
      intent: Share assets with external recipients
      effect: write
      questions:
      - How do I send a set of assets to a prospect as a view-only link?
      - Can I make a share expire on a certain date or block downloads?
      - How many assets can go into one Showpad share?
      instructions:
      - text: Create a share titled {title} with assets {assets} from {origin}.
        slots:
          title: requestBody.title
          assets: requestBody.assets
          origin: requestBody.origin
      - text: Share assets {assets} as {title} from {origin}, expiring at {expiresAt}, downloads allowed {isDownloadAllowed}.
        slots:
          title: requestBody.title
          assets: requestBody.assets
          origin: requestBody.origin
          expiresAt: requestBody.expiresAt
          isDownloadAllowed: requestBody.isDownloadAllowed
      method: generated
      generated: '2026-10-01'