Jupyter Notebook REST API — Terminals

naftiko: 1.0.0-alpha2
info:
  label: Jupyter Notebook REST API — Terminals
  description: 'Jupyter Notebook REST API — Terminals. 4 operations. Lead operation: Jupyter Notebook List running terminals.
    Self-contained Naftiko capability covering one Jupyter Notebook business surface.'
  tags:
  - Jupyter Notebook
  - Terminals
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    JUPYTER_NOTEBOOK_API_KEY: JUPYTER_NOTEBOOK_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-terminals
    baseUri: http://localhost:8888/api
    description: Jupyter Notebook REST API — Terminals business capability. Self-contained, no shared references.
    resources:
    - name: api-terminals
      path: /api/terminals
      operations:
      - name: listterminals
        method: GET
        description: Jupyter Notebook List running terminals
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createterminal
        method: POST
        description: Jupyter Notebook Create a new terminal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-terminals-terminal_id
      path: /api/terminals/{terminal_id}
      operations:
      - name: getterminal
        method: GET
        description: Jupyter Notebook Get terminal information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: terminal_id
          in: path
          type: string
          description: Identifier for the terminal session.
          required: true
      - name: deleteterminal
        method: DELETE
        description: Jupyter Notebook Shut down a terminal
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: terminal_id
          in: path
          type: string
          description: Identifier for the terminal session.
          required: true
    authentication:
      type: apikey
      key: token
      value: '{{env.JUPYTER_NOTEBOOK_API_KEY}}'
      placement: query
  exposes:
  - type: rest
    namespace: rest-terminals-rest
    port: 8080
    description: REST adapter for Jupyter Notebook REST API — Terminals. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/terminals
      name: api-terminals
      description: REST surface for api-terminals.
      operations:
      - method: GET
        name: listterminals
        description: Jupyter Notebook List running terminals
        call: rest-terminals.listterminals
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createterminal
        description: Jupyter Notebook Create a new terminal
        call: rest-terminals.createterminal
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/terminals/{terminal-id}
      name: api-terminals-terminal-id
      description: REST surface for api-terminals-terminal_id.
      operations:
      - method: GET
        name: getterminal
        description: Jupyter Notebook Get terminal information
        call: rest-terminals.getterminal
        with:
          terminal_id: rest.terminal_id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteterminal
        description: Jupyter Notebook Shut down a terminal
        call: rest-terminals.deleteterminal
        with:
          terminal_id: rest.terminal_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-terminals-mcp
    port: 9090
    transport: http
    description: MCP adapter for Jupyter Notebook REST API — Terminals. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: jupyter-notebook-list-running-terminals
      description: Jupyter Notebook List running terminals
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-terminals.listterminals
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-notebook-create-new-terminal
      description: Jupyter Notebook Create a new terminal
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-terminals.createterminal
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-notebook-get-terminal-information
      description: Jupyter Notebook Get terminal information
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-terminals.getterminal
      with:
        terminal_id: tools.terminal_id
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-notebook-shut-down-terminal
      description: Jupyter Notebook Shut down a terminal
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-terminals.deleteterminal
      with:
        terminal_id: tools.terminal_id
      outputParameters:
      - type: object
        mapping: $.