# 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 Plugins API
  version: 1.0.0
extends: openapi/sigma-computing-plugins-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: 5
- target: $.paths['/v2/plugins'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom plugins
      effect: read
      questions:
      - Which custom plugins are registered in my organization?
      - Can I page through my organization's custom plugins?
      instructions:
      - text: List our custom plugins.
      - text: List custom plugins, {pageSize} per page.
        slots:
          pageSize: query.pageSize
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/plugins'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a custom plugin
      effect: write
      questions:
      - How do I register a new custom plugin for workbooks?
      - What happens if I create a plugin without a production URL?
      instructions:
      - text: Register a custom plugin named {name} at {url}.
        slots:
          name: requestBody.name
          url: requestBody.url
      - text: Create plugin {name} with development URL {devUrl}.
        slots:
          name: requestBody.name
          devUrl: requestBody.devUrl
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/plugins/{pluginId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom plugin's metadata
      effect: read
      questions:
      - What are the name and URLs of a specific custom plugin?
      - Can I look up a plugin by its ID?
      instructions:
      - text: Get custom plugin {pluginId}.
        slots:
          pluginId: path.pluginId
      - text: Show metadata for plugin {pluginId}.
        slots:
          pluginId: path.pluginId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/plugins/{pluginId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a custom plugin
      effect: destructive
      questions:
      - How do I permanently delete a custom plugin?
      - What happens to workbook elements that use a deleted plugin?
      instructions:
      - text: Delete custom plugin {pluginId}.
        slots:
          pluginId: path.pluginId
      - text: Permanently remove plugin {pluginId}.
        slots:
          pluginId: path.pluginId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/plugins/{pluginId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a custom plugin's name or dev URL
      effect: write
      questions:
      - How do I rename a custom plugin or change its dev URL?
      - Can I change a plugin's production URL with the update call?
      instructions:
      - text: Rename plugin {pluginId} to {name}.
        slots:
          pluginId: path.pluginId
          name: requestBody.name
      - text: Set plugin {pluginId}'s development URL to {devUrl}.
        slots:
          pluginId: path.pluginId
          devUrl: requestBody.devUrl
      method: generated
      generated: '2026-09-26'