Showpad · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Showpad Shared Spaces API

8 actions 8 updates phrasing extends openapi/showpad-shared-spaces-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 8

$.info
$.paths['/shared-spaces'].get
$.paths['/shared-spaces'].post
$.paths['/shared-spaces/{shareId}'].get
$.paths['/shared-spaces/{shareId}'].delete
$.paths['/shared-spaces/{shareId}'].patch
$.paths['/shared-spaces/{shareId}/transfer-ownership'].post
$.paths['/shared-spaces/{shareId}/items'].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 Shared Spaces API
  version: 1.0.0
extends: openapi/showpad-shared-spaces-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: 7
- target: $.paths['/shared-spaces'].get
  update:
    x-apievangelist-phrasing:
      intent: List shared spaces
      effect: read
      questions:
      - Which shared spaces have I created or been invited to?
      - Can I find shared spaces with a particular buyer's email as participant?
      - How do I see spaces with no activity since a given date or whose owner was deactivated?
      instructions:
      - text: List shared spaces titled {title}.
        slots:
          title: query.title
      - text: Show shared spaces where {participantEmail} is a participant.
        slots:
          participantEmail: query.participantEmail
      - text: List spaces owned by user {ownerUserId} with activity since {lastActivitySince}.
        slots:
          ownerUserId: query.ownerUserId
          lastActivitySince: query.lastActivitySince
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shared-spaces'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shared space
      effect: write
      questions:
      - How do I open a new shared space for a buyer?
      - Can I let external guests upload files or invite others when I create a space?
      - Is it possible to start a shared space from a template with a theme?
      instructions:
      - text: Create a shared space titled {title} described as {description}.
        slots:
          title: requestBody.title
          description: requestBody.description
      - text: Create a shared space {title} from template {sharedSpaceTemplate} with theme {theme}.
        slots:
          title: requestBody.title
          sharedSpaceTemplate: requestBody.sharedSpaceTemplate
          theme: requestBody.theme
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shared-spaces/{shareId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shared space's details
      effect: read
      questions:
      - How do I view the settings and details of one shared space?
      - What information is returned for a single shared space?
      instructions:
      - text: Show me the details of shared space {shareId}.
        slots:
          shareId: path.shareId
      - text: Open shared space {shareId} and summarize its settings.
        slots:
          shareId: path.shareId
      method: generated
      generated: '2026-10-02'
- target: $.paths['/shared-spaces/{shareId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shared space
      effect: destructive
      questions:
      - How do I permanently delete a shared space?
      - What call removes a shared space I no longer need?
      instructions:
      - text: Delete shared space {shareId}.
        slots:
          shareId: path.shareId
      - text: Remove the shared space with ID {shareId}.
        slots:
          shareId: path.shareId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shared-spaces/{shareId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a shared space's settings
      effect: write
      questions:
      - How do I rename a shared space or change its description?
      - Can I turn off comments or external downloads on an existing space?
      instructions:
      - text: Rename shared space {shareId} to {title}.
        slots:
          shareId: path.shareId
          title: requestBody.title
      - text: Set external downloads to {isExternalDownloadAllowed} on shared space {shareId}.
        slots:
          isExternalDownloadAllowed: requestBody.isExternalDownloadAllowed
          shareId: path.shareId
      - text: Change shared space {shareId} status to {status}.
        slots:
          shareId: path.shareId
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shared-spaces/{shareId}/transfer-ownership'].post
  update:
    x-apievangelist-phrasing:
      intent: Transfer ownership of a shared space
      effect: write
      questions:
      - How do I hand a shared space over to a colleague when a rep leaves?
      - Can I make another user the owner of a shared space?
      instructions:
      - text: Transfer ownership of shared space {shareId} to user {userId}.
        slots:
          shareId: path.shareId
          userId: requestBody.userId
      - text: Make {userId} the new owner of space {shareId}.
        slots:
          userId: requestBody.userId
          shareId: path.shareId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shared-spaces/{shareId}/items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add files and folders to a shared space
      effect: write
      questions:
      - How do I put files into a shared space?
      - Can I create folders with nested items while adding content to a space?
      instructions:
      - text: Add items {items} to shared space {shareId}.
        slots:
          items: requestBody.items
          shareId: path.shareId
      - text: Upload this folder structure {items} into space {shareId}.
        slots:
          items: requestBody.items
          shareId: path.shareId
      method: generated
      generated: '2026-10-01'