Sigma Computing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sigma Computing Favorites API

4 actions 4 updates phrasing extends openapi/sigma-computing-favorites-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Sigma Computing's API. It is a proposal applied on top of the contract, not a document Sigma Computing publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/v2/favorites'].post

$.paths['/v2/favorites/member/{memberId}'].get

$.paths['/v2/favorites/member/{memberId}/file/{inodeId}'].delete

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 Sigma Computing Favorites API
  version: 1.0.0
extends: openapi/sigma-computing-favorites-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/v2/favorites'].post
  update:
    x-apievangelist-phrasing:
      intent: Favorite a document for a user
      effect: write
      questions:
      - How do I add a workbook or folder to someone's favorites?
      - Can I favorite a document on behalf of another member?
      instructions:
      - text: Favorite document {inodeId} for member {memberId}.
        slots:
          inodeId: requestBody.inodeId
          memberId: requestBody.memberId
      - text: Add folder {inodeId} to {memberId}'s favorites.
        slots:
          inodeId: requestBody.inodeId
          memberId: requestBody.memberId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/favorites/member/{memberId}'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's favorite documents
      effect: read
      questions:
      - What documents has a user marked as favorites?
      - Can I page through a member's favorites?
      instructions:
      - text: List the favorites of member {memberId}.
        slots:
          memberId: path.memberId
      - text: Show {memberId}'s favorite documents, {limit} per page.
        slots:
          memberId: path.memberId
          limit: query.limit
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/favorites/member/{memberId}/file/{inodeId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unfavorite a document for a user
      effect: destructive
      questions:
      - How do I remove a document from a user's favorites?
      - Can I unfavorite a folder for another member?
      instructions:
      - text: Unfavorite document {inodeId} for member {memberId}.
        slots:
          inodeId: path.inodeId
          memberId: path.memberId
      - text: Remove {inodeId} from {memberId}'s favorites.
        slots:
          inodeId: path.inodeId
          memberId: path.memberId
      method: generated
      generated: '2026-09-26'