Jupyter Server REST API — Sessions

naftiko: 1.0.0-alpha2
info:
  label: Jupyter Server REST API — Sessions
  description: 'Jupyter Server REST API — Sessions. 5 operations. Lead operation: Jupyter Server List sessions. Self-contained
    Naftiko capability covering one Jupyter Server business surface.'
  tags:
  - Jupyter Server
  - Sessions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    JUPYTER_SERVER_API_KEY: JUPYTER_SERVER_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-sessions
    baseUri: http://localhost:8888/api
    description: Jupyter Server REST API — Sessions business capability. Self-contained, no shared references.
    resources:
    - name: sessions
      path: /sessions
      operations:
      - name: listsessions
        method: GET
        description: Jupyter Server List sessions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createsession
        method: POST
        description: Jupyter Server Create session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: sessions-session
      path: /sessions/{session}
      operations:
      - name: getsession
        method: GET
        description: Jupyter Server Get session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: session
          in: path
          type: string
          required: true
      - name: updatesession
        method: PATCH
        description: Jupyter Server Update session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: session
          in: path
          type: string
          required: true
      - name: deletesession
        method: DELETE
        description: Jupyter Server Delete session
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: session
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.JUPYTER_SERVER_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: rest-sessions-rest
    port: 8080
    description: REST adapter for Jupyter Server REST API — Sessions. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/sessions
      name: sessions
      description: REST surface for sessions.
      operations:
      - method: GET
        name: listsessions
        description: Jupyter Server List sessions
        call: rest-sessions.listsessions
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsession
        description: Jupyter Server Create session
        call: rest-sessions.createsession
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/sessions/{session}
      name: sessions-session
      description: REST surface for sessions-session.
      operations:
      - method: GET
        name: getsession
        description: Jupyter Server Get session
        call: rest-sessions.getsession
        with:
          session: rest.session
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatesession
        description: Jupyter Server Update session
        call: rest-sessions.updatesession
        with:
          session: rest.session
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesession
        description: Jupyter Server Delete session
        call: rest-sessions.deletesession
        with:
          session: rest.session
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-sessions-mcp
    port: 9090
    transport: http
    description: MCP adapter for Jupyter Server REST API — Sessions. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: jupyter-server-list-sessions
      description: Jupyter Server List sessions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-sessions.listsessions
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-server-create-session
      description: Jupyter Server Create session
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-sessions.createsession
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-server-get-session
      description: Jupyter Server Get session
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-sessions.getsession
      with:
        session: tools.session
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-server-update-session
      description: Jupyter Server Update session
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rest-sessions.updatesession
      with:
        session: tools.session
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-server-delete-session
      description: Jupyter Server Delete session
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-sessions.deletesession
      with:
        session: tools.session
      outputParameters:
      - type: object
        mapping: $.