Jupyter Notebook REST API — Sessions

naftiko: 1.0.0-alpha2
info:
  label: Jupyter Notebook REST API — Sessions
  description: 'Jupyter Notebook REST API — Sessions. 5 operations. Lead operation: Jupyter Notebook List running sessions.
    Self-contained Naftiko capability covering one Jupyter Notebook business surface.'
  tags:
  - Jupyter Notebook
  - Sessions
  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-sessions
    baseUri: http://localhost:8888/api
    description: Jupyter Notebook REST API — Sessions business capability. Self-contained, no shared references.
    resources:
    - name: api-sessions
      path: /api/sessions
      operations:
      - name: listsessions
        method: GET
        description: Jupyter Notebook List running sessions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createsession
        method: POST
        description: Jupyter Notebook Create a new session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-sessions-session_id
      path: /api/sessions/{session_id}
      operations:
      - name: getsession
        method: GET
        description: Jupyter Notebook Get a session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: session_id
          in: path
          type: string
          description: Unique identifier for the session.
          required: true
      - name: updatesession
        method: PATCH
        description: Jupyter Notebook Update a session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: session_id
          in: path
          type: string
          description: Unique identifier for the session.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletesession
        method: DELETE
        description: Jupyter Notebook Delete a session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: session_id
          in: path
          type: string
          description: Unique identifier for the session.
          required: true
    authentication:
      type: apikey
      key: token
      value: '{{env.JUPYTER_NOTEBOOK_API_KEY}}'
      placement: query
  exposes:
  - type: rest
    namespace: rest-sessions-rest
    port: 8080
    description: REST adapter for Jupyter Notebook REST API — Sessions. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/sessions
      name: api-sessions
      description: REST surface for api-sessions.
      operations:
      - method: GET
        name: listsessions
        description: Jupyter Notebook List running sessions
        call: rest-sessions.listsessions
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsession
        description: Jupyter Notebook Create a new session
        call: rest-sessions.createsession
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/sessions/{session-id}
      name: api-sessions-session-id
      description: REST surface for api-sessions-session_id.
      operations:
      - method: GET
        name: getsession
        description: Jupyter Notebook Get a session
        call: rest-sessions.getsession
        with:
          session_id: rest.session_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatesession
        description: Jupyter Notebook Update a session
        call: rest-sessions.updatesession
        with:
          session_id: rest.session_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesession
        description: Jupyter Notebook Delete a session
        call: rest-sessions.deletesession
        with:
          session_id: rest.session_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-sessions-mcp
    port: 9090
    transport: http
    description: MCP adapter for Jupyter Notebook REST API — Sessions. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: jupyter-notebook-list-running-sessions
      description: Jupyter Notebook List running sessions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-sessions.listsessions
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-notebook-create-new-session
      description: Jupyter Notebook Create a new session
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-sessions.createsession
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-notebook-get-session
      description: Jupyter Notebook Get a session
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-sessions.getsession
      with:
        session_id: tools.session_id
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-notebook-update-session
      description: Jupyter Notebook Update a session
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-sessions.updatesession
      with:
        session_id: tools.session_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-notebook-delete-session
      description: Jupyter Notebook Delete a session
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-sessions.deletesession
      with:
        session_id: tools.session_id
      outputParameters:
      - type: object
        mapping: $.