Jupyter Server REST API — Checkpoints

naftiko: 1.0.0-alpha2
info:
  label: Jupyter Server REST API — Checkpoints
  description: 'Jupyter Server REST API — Checkpoints. 4 operations. Lead operation: Jupyter Server List checkpoints. Self-contained
    Naftiko capability covering one Jupyter Server business surface.'
  tags:
  - Jupyter Server
  - Checkpoints
  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-checkpoints
    baseUri: http://localhost:8888/api
    description: Jupyter Server REST API — Checkpoints business capability. Self-contained, no shared references.
    resources:
    - name: contents-path-checkpoints
      path: /contents/{path}/checkpoints
      operations:
      - name: listcheckpoints
        method: GET
        description: Jupyter Server List checkpoints
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: path
          in: path
          type: string
          required: true
      - name: createcheckpoint
        method: POST
        description: Jupyter Server Create checkpoint
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: path
          in: path
          type: string
          required: true
    - name: contents-path-checkpoints-checkpoint_id
      path: /contents/{path}/checkpoints/{checkpoint_id}
      operations:
      - name: restorecheckpoint
        method: POST
        description: Jupyter Server Restore checkpoint
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: path
          in: path
          type: string
          required: true
        - name: checkpoint_id
          in: path
          type: string
          required: true
      - name: deletecheckpoint
        method: DELETE
        description: Jupyter Server Delete checkpoint
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: path
          in: path
          type: string
          required: true
        - name: checkpoint_id
          in: path
          type: string
          required: true
    authentication:
      type: apikey
      key: Authorization
      value: '{{env.JUPYTER_SERVER_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: rest-checkpoints-rest
    port: 8080
    description: REST adapter for Jupyter Server REST API — Checkpoints. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/contents/{path}/checkpoints
      name: contents-path-checkpoints
      description: REST surface for contents-path-checkpoints.
      operations:
      - method: GET
        name: listcheckpoints
        description: Jupyter Server List checkpoints
        call: rest-checkpoints.listcheckpoints
        with:
          path: rest.path
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcheckpoint
        description: Jupyter Server Create checkpoint
        call: rest-checkpoints.createcheckpoint
        with:
          path: rest.path
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/contents/{path}/checkpoints/{checkpoint-id}
      name: contents-path-checkpoints-checkpoint-id
      description: REST surface for contents-path-checkpoints-checkpoint_id.
      operations:
      - method: POST
        name: restorecheckpoint
        description: Jupyter Server Restore checkpoint
        call: rest-checkpoints.restorecheckpoint
        with:
          path: rest.path
          checkpoint_id: rest.checkpoint_id
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecheckpoint
        description: Jupyter Server Delete checkpoint
        call: rest-checkpoints.deletecheckpoint
        with:
          path: rest.path
          checkpoint_id: rest.checkpoint_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-checkpoints-mcp
    port: 9090
    transport: http
    description: MCP adapter for Jupyter Server REST API — Checkpoints. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: jupyter-server-list-checkpoints
      description: Jupyter Server List checkpoints
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-checkpoints.listcheckpoints
      with:
        path: tools.path
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-server-create-checkpoint
      description: Jupyter Server Create checkpoint
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-checkpoints.createcheckpoint
      with:
        path: tools.path
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-server-restore-checkpoint
      description: Jupyter Server Restore checkpoint
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-checkpoints.restorecheckpoint
      with:
        path: tools.path
        checkpoint_id: tools.checkpoint_id
      outputParameters:
      - type: object
        mapping: $.
    - name: jupyter-server-delete-checkpoint
      description: Jupyter Server Delete checkpoint
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-checkpoints.deletecheckpoint
      with:
        path: tools.path
        checkpoint_id: tools.checkpoint_id
      outputParameters:
      - type: object
        mapping: $.