Sigma Computing · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Sigma Computing Grants API

5 actions 5 updates phrasing extends openapi/sigma-computing-grants-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 5

$.info
$.paths['/v2/grants'].get
$.paths['/v2/grants'].post
$.paths['/v2/grants/{grantId}'].get
$.paths['/v2/grants/{grantId}'].delete

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 Sigma Computing Grants API
  version: 1.0.0
extends: openapi/sigma-computing-grants-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: 4
- target: $.paths['/v2/grants'].get
  update:
    x-apievangelist-phrasing:
      intent: List permission grants for a document, user or team
      effect: read
      questions:
      - Who has access to a particular document or folder?
      - What grants does a given user or team hold?
      - Can I list only direct grants and skip inherited ones?
      instructions:
      - text: List grants on document {inodeId}.
        slots:
          inodeId: query.inodeId
      - text: List the grants held by team {teamId}.
        slots:
          teamId: query.teamId
      - text: List direct grants only for user {userId}.
        slots:
          userId: query.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/grants'].post
  update:
    x-apievangelist-phrasing:
      intent: Grant access to a document, folder or workspace
      effect: write
      questions:
      - How do I give a user edit access to a folder or workspace?
      - Can I raise someone's permission level on a document?
      instructions:
      - text: Grant {permission} on {inodeId} to {grantee}.
        slots:
          permission: requestBody.permission
          inodeId: requestBody.inodeId
          grantee: requestBody.grantee
      - text: Give {grantee} {permission} access to workspace {inodeId}.
        slots:
          grantee: requestBody.grantee
          permission: requestBody.permission
          inodeId: requestBody.inodeId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/grants/{grantId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a grant by ID
      effect: read
      questions:
      - What permission and grantee does a specific grant have?
      - Can I inspect one grant object by its ID?
      instructions:
      - text: Get grant {grantId}.
        slots:
          grantId: path.grantId
      - text: Show the details of grant {grantId}.
        slots:
          grantId: path.grantId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/grants/{grantId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a grant by ID
      effect: destructive
      questions:
      - How do I revoke a document or folder permission by its grant ID?
      - Can I delete any grant if I know its ID?
      instructions:
      - text: Delete grant {grantId}.
        slots:
          grantId: path.grantId
      - text: Revoke the access given by grant {grantId}.
        slots:
          grantId: path.grantId
      method: generated
      generated: '2026-09-26'