SingleStore Management API — Workspaces

naftiko: 1.0.0-alpha2
info:
  label: SingleStore Management API — Workspaces
  description: 'SingleStore Management API — Workspaces. 7 operations. Lead operation: List Workspaces. Self-contained Naftiko
    capability covering one Singlestore business surface.'
  tags:
  - Singlestore
  - Workspaces
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SINGLESTORE_API_KEY: SINGLESTORE_API_KEY
capability:
  consumes:
  - type: http
    namespace: management-workspaces
    baseUri: https://api.singlestore.com/v1
    description: SingleStore Management API — Workspaces business capability. Self-contained, no shared references.
    resources:
    - name: workspaces
      path: /workspaces
      operations:
      - name: listworkspaces
        method: GET
        description: List Workspaces
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspaceGroupID
          in: query
          type: string
          description: Filter workspaces by the unique ID of the workspace group they belong to.
      - name: createworkspace
        method: POST
        description: Create a Workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: workspaces-workspaceID
      path: /workspaces/{workspaceID}
      operations:
      - name: getworkspace
        method: GET
        description: Get a Workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateworkspace
        method: PATCH
        description: Update a Workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: terminateworkspace
        method: DELETE
        description: Terminate a Workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: force
          in: query
          type: boolean
          description: When set to true, forces termination of the workspace even if it is in an intermediate state.
    - name: workspaces-workspaceID-resume
      path: /workspaces/{workspaceID}/resume
      operations:
      - name: resumeworkspace
        method: POST
        description: Resume a Workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: workspaces-workspaceID-suspend
      path: /workspaces/{workspaceID}/suspend
      operations:
      - name: suspendworkspace
        method: POST
        description: Suspend a Workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.SINGLESTORE_API_KEY}}'
  exposes:
  - type: rest
    namespace: management-workspaces-rest
    port: 8080
    description: REST adapter for SingleStore Management API — Workspaces. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/workspaces
      name: workspaces
      description: REST surface for workspaces.
      operations:
      - method: GET
        name: listworkspaces
        description: List Workspaces
        call: management-workspaces.listworkspaces
        with:
          workspaceGroupID: rest.workspaceGroupID
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createworkspace
        description: Create a Workspace
        call: management-workspaces.createworkspace
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workspaces/{workspaceid}
      name: workspaces-workspaceid
      description: REST surface for workspaces-workspaceID.
      operations:
      - method: GET
        name: getworkspace
        description: Get a Workspace
        call: management-workspaces.getworkspace
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateworkspace
        description: Update a Workspace
        call: management-workspaces.updateworkspace
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: terminateworkspace
        description: Terminate a Workspace
        call: management-workspaces.terminateworkspace
        with:
          force: rest.force
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workspaces/{workspaceid}/resume
      name: workspaces-workspaceid-resume
      description: REST surface for workspaces-workspaceID-resume.
      operations:
      - method: POST
        name: resumeworkspace
        description: Resume a Workspace
        call: management-workspaces.resumeworkspace
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/workspaces/{workspaceid}/suspend
      name: workspaces-workspaceid-suspend
      description: REST surface for workspaces-workspaceID-suspend.
      operations:
      - method: POST
        name: suspendworkspace
        description: Suspend a Workspace
        call: management-workspaces.suspendworkspace
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: management-workspaces-mcp
    port: 9090
    transport: http
    description: MCP adapter for SingleStore Management API — Workspaces. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-workspaces
      description: List Workspaces
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: management-workspaces.listworkspaces
      with:
        workspaceGroupID: tools.workspaceGroupID
      outputParameters:
      - type: object
        mapping: $.
    - name: create-workspace
      description: Create a Workspace
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: management-workspaces.createworkspace
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-workspace
      description: Get a Workspace
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: management-workspaces.getworkspace
      outputParameters:
      - type: object
        mapping: $.
    - name: update-workspace
      description: Update a Workspace
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: management-workspaces.updateworkspace
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: terminate-workspace
      description: Terminate a Workspace
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: management-workspaces.terminateworkspace
      with:
        force: tools.force
      outputParameters:
      - type: object
        mapping: $.
    - name: resume-workspace
      description: Resume a Workspace
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: management-workspaces.resumeworkspace
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: suspend-workspace
      description: Suspend a Workspace
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: management-workspaces.suspendworkspace
      outputParameters:
      - type: object
        mapping: $.