Showpad · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Showpad Shared Spaces Quick Actions API

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

$.info
$.paths['/shared-spaces/{shareId}/quick-actions'].get
$.paths['/shared-spaces/{shareId}/quick-actions'].post
$.paths['/shared-spaces/{shareId}/quick-actions/{quickActionId}'].get
$.paths['/shared-spaces/{shareId}/quick-actions/{quickActionId}'].delete
$.paths['/shared-spaces/{shareId}/quick-actions/{quickActionId}'].patch

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 Quick Actions API
  version: 1.0.0
extends: openapi/showpad-shared-spaces-quick-actions-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: 5
- target: $.paths['/shared-spaces/{shareId}/quick-actions'].get
  update:
    x-apievangelist-phrasing:
      intent: List a Shared Space's quick actions
      effect: read
      questions:
      - Which quick actions are set up in a Shared Space?
      - What links do buyers see as quick actions in my Shared Space?
      instructions:
      - text: List the quick actions in Shared Space {shareId}.
        slots:
          shareId: path.shareId
      - text: Show every quick action configured for Shared Space {shareId}.
        slots:
          shareId: path.shareId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shared-spaces/{shareId}/quick-actions'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a quick action to a Shared Space
      effect: write
      questions:
      - How do I add an external link as a quick action in a Shared Space?
      - Can I make a quick action visible only to the seller and not the buyer?
      instructions:
      - text: Add quick action {title} linking to {url} in Shared Space {shareId} using extension {sharedSpaceExtensionId}.
        slots:
          shareId: path.shareId
          title: requestBody.title
          url: requestBody.url
          sharedSpaceExtensionId: requestBody.sharedSpaceExtensionId
      - text: Create a seller-only quick action {title} for {url} in Shared Space {shareId} with extension {sharedSpaceExtensionId}, internal {isInternal}.
        slots:
          shareId: path.shareId
          title: requestBody.title
          url: requestBody.url
          sharedSpaceExtensionId: requestBody.sharedSpaceExtensionId
          isInternal: requestBody.isInternal
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shared-spaces/{shareId}/quick-actions/{quickActionId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Shared Space quick action
      effect: read
      questions:
      - How do I see the details of one quick action in a Shared Space?
      - Is a specific quick action shown to buyers or only to the seller?
      instructions:
      - text: Get quick action {quickActionId} in Shared Space {shareId}.
        slots:
          shareId: path.shareId
          quickActionId: path.quickActionId
      - text: Show the title and URL of quick action {quickActionId} in Shared Space {shareId}.
        slots:
          shareId: path.shareId
          quickActionId: path.quickActionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shared-spaces/{shareId}/quick-actions/{quickActionId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a quick action from a Shared Space
      effect: destructive
      questions:
      - How do I remove a quick action from a Shared Space?
      - Can I delete a quick action buyers no longer need?
      instructions:
      - text: Delete quick action {quickActionId} from Shared Space {shareId}.
        slots:
          shareId: path.shareId
          quickActionId: path.quickActionId
      - text: Remove quick action {quickActionId} in Shared Space {shareId}.
        slots:
          shareId: path.shareId
          quickActionId: path.quickActionId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/shared-spaces/{shareId}/quick-actions/{quickActionId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a Shared Space quick action
      effect: write
      questions:
      - How do I change the link or title of an existing quick action?
      - Can I switch an existing quick action between seller-only and buyer-visible?
      instructions:
      - text: Change quick action {quickActionId} in Shared Space {shareId} to point at {url}.
        slots:
          shareId: path.shareId
          quickActionId: path.quickActionId
          url: requestBody.url
      - text: Rename quick action {quickActionId} in Shared Space {shareId} to {title}.
        slots:
          shareId: path.shareId
          quickActionId: path.quickActionId
          title: requestBody.title
      - text: Set internal to {isInternal} on quick action {quickActionId} in Shared Space {shareId}.
        slots:
          shareId: path.shareId
          quickActionId: path.quickActionId
          isInternal: requestBody.isInternal
      method: generated
      generated: '2026-10-01'