Jupyter Notebook Kernelspecs API

openapi: 3.2.0
info:
  title: Jupyter Notebook REST Kernelspecs API
  description: REST API for managing and interacting with Jupyter Notebook servers, including kernels, sessions, contents (notebooks and files), terminals, and kernel specifications. This API is served by the Jupyter Notebook server (or Jupyter Server) and provides programmatic access to all notebook server functionality.
  version: 7.0.0
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  contact:
    name: Jupyter Project
    url: https://jupyter.org
    email: jupyter@googlegroups.com
servers:
- url: http://localhost:8888/api
  description: Local Jupyter Notebook server
security:
- token: []
- tokenHeader: []
tags:
- name: Kernelspecs
  description: Kernel specification listing and retrieval for available kernel types.
paths:
  /api/kernelspecs:
    get:
      operationId: listKernelSpecs
      summary: Jupyter Notebook List kernel specifications
      description: Get the list of available kernel specifications. Returns the default kernel name and a mapping of kernel spec names to their specifications.
      tags:
      - Kernelspecs
      responses:
        '200':
          description: Kernel specifications listing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KernelSpecList'
  /api/kernelspecs/{kernel_name}:
    get:
      operationId: getKernelSpec
      summary: Jupyter Notebook Get a kernel specification
      description: Get the specification for a specific kernel by name.
      tags:
      - Kernelspecs
      parameters:
      - name: kernel_name
        in: path
        required: true
        description: Name of the kernel specification.
        schema:
          type: string
      responses:
        '200':
          description: Kernel specification details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KernelSpec'
        '404':
          description: Kernel spec not found.
components:
  schemas:
    KernelSpec:
      type: object
      description: A kernel specification.
      properties:
        name:
          type: string
          description: Unique name of the kernel specification.
        spec:
          type: object
          description: The kernel specification details.
          properties:
            language:
              type: string
              description: The programming language of the kernel.
            display_name:
              type: string
              description: Human-readable name for the kernel.
            argv:
              type: array
              description: Command line arguments to launch the kernel.
              items:
                type: string
            env:
              type: object
              description: Environment variables for the kernel.
              additionalProperties:
                type: string
            metadata:
              type: object
              description: Additional metadata about the kernel.
              additionalProperties: true
          required:
          - language
          - display_name
          - argv
        resources:
          type: object
          description: Resource files associated with the kernel spec (e.g., logos).
          additionalProperties:
            type: string
      required:
      - name
      - spec
      - resources
    KernelSpecList:
      type: object
      description: List of available kernel specifications.
      properties:
        default:
          type: string
          description: Name of the default kernel specification.
        kernelspecs:
          type: object
          description: Mapping of kernel spec names to their specifications.
          additionalProperties:
            $ref: '#/components/schemas/KernelSpec'
      required:
      - default
      - kernelspecs
  securitySchemes:
    token:
      type: apiKey
      in: query
      name: token
      description: Authentication token passed as a query parameter.
    tokenHeader:
      type: apiKey
      in: header
      name: Authorization
      description: Authentication token passed in the Authorization header as 'token <token_value>'.