Showpad · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Showpad Recommendations API

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

$.info
$.paths['/recommendations/assets/new'].get
$.paths['/recommendations/assets/popular'].get
$.paths['/recommendations/assets/trending'].get
$.paths['/recommendations/assets/updated'].get
$.paths['/recommendations/experiences/new'].get
$.paths['/recommendations/experiences/popular'].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 Recommendations API
  version: 1.0.0
extends: openapi/showpad-recommendations-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: 6
- target: $.paths['/recommendations/assets/new'].get
  update:
    x-apievangelist-phrasing:
      intent: Recommend newly assigned assets
      effect: read
      questions:
      - Which assets were recently made available to me that I haven't opened yet?
      - Can I see new assets assigned since a certain date with specific tags?
      instructions:
      - text: Show assets newly assigned to me since {assignedAfter}.
        slots:
          assignedAfter: query.assignedAfter
      - text: List new assets that have all tags {conjunctiveTagIds}.
        slots:
          conjunctiveTagIds: query.conjunctiveTagIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/recommendations/assets/popular'].get
  update:
    x-apievangelist-phrasing:
      intent: Recommend popular assets
      effect: read
      questions:
      - What content performs best over the long term on views or shares?
      - Can I rank popular assets by team activity instead of just my own?
      instructions:
      - text: Show the most popular assets ranked by {activityScope}.
        slots:
          activityScope: query.activityScope
      - text: List long-term popular assets between {startedAt} and {endedAt}.
        slots:
          startedAt: query.startedAt
          endedAt: query.endedAt
      method: generated
      generated: '2026-10-01'
- target: $.paths['/recommendations/assets/trending'].get
  update:
    x-apievangelist-phrasing:
      intent: Recommend trending assets
      effect: read
      questions:
      - Which assets are getting a spike in attention right now?
      - Can I see what's trending among other users while excluding certain tags?
      instructions:
      - text: Show trending assets for user scope {userScope}.
        slots:
          userScope: query.userScope
      - text: List assets with rising engagement, excluding tags {excludedTagIds}.
        slots:
          excludedTagIds: query.excludedTagIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/recommendations/assets/updated'].get
  update:
    x-apievangelist-phrasing:
      intent: Recommend recently updated assets
      effect: read
      questions:
      - Which assets have been updated lately that I haven't looked at?
      - Can I see content changed since a specific date?
      instructions:
      - text: Show assets updated since {updatedAfter}.
        slots:
          updatedAfter: query.updatedAfter
      - text: List recently updated assets with any of tags {disjunctiveTagIds}.
        slots:
          disjunctiveTagIds: query.disjunctiveTagIds
      method: generated
      generated: '2026-10-01'
- target: $.paths['/recommendations/experiences/new'].get
  update:
    x-apievangelist-phrasing:
      intent: Recommend newly assigned experiences
      effect: read
      questions:
      - Which experiences were recently assigned to me?
      - Can I see new experiences I haven't viewed since a certain date?
      instructions:
      - text: Show experiences newly assigned to me since {assignedAfter}.
        slots:
          assignedAfter: query.assignedAfter
      - text: List new experiences I haven't viewed after {notViewedAfter}.
        slots:
          notViewedAfter: query.notViewedAfter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/recommendations/experiences/popular'].get
  update:
    x-apievangelist-phrasing:
      intent: Recommend popular experiences
      effect: read
      questions:
      - Which experiences get the most views or shares?
      - Can I measure experience popularity over a specific date range?
      instructions:
      - text: Show the most popular experiences.
      - text: List popular experiences based on activity from {startedAt} to {endedAt}.
        slots:
          startedAt: query.startedAt
          endedAt: query.endedAt
      method: generated
      generated: '2026-10-01'