Jupyter Starters JSON Schema

v2.json

A collection of JSON types for configuring and operating Starters

| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | | :——————— | :——— | :————- | :———————- | :—————- | :——————– | :—————— | :– | | Cannot be instantiated | Yes | Unknown status | Unknown identifiability | Forbidden | Allowed | none | |

Jupyter Starters JSON Type

object ()

any of

Jupyter Starters JSON Definitions

Definitions group all-starters

Reference this group by using

{
  "$ref": "v2.json#/definitions/all-starters"
}

starters

a named set of Starters

starters

is required
Type: object (Starters)
cannot be null
defined in:

starters Type

object (Starters)

running

Starters currently using a process/resource

running

is optional
Type: string[]
cannot be null
defined in:

running Type

string[]

version

The version of the Jupyter Starters API

version

is required
Type: string (API Version)
cannot be null
defined in:

version Type

string (API Version)

version Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
`"2"`

Definitions group starters

Reference this group by using

{
  "$ref": "v2.json#/definitions/starters"
}

Additional Properties

Additional properties are allowed, as long as they follow this schema:

is optional
Type: object (Starter)
cannot be null
defined in:

additionalProperties Type

object (Starter)

any of

all of
- Starter Metadata
- Starter with Files
all of
- all of
  - Starter Metadata
  - Starter with Files
all of
- Starter Metadata
all of
- Starter Metadata
- Starter with Files

Definitions group start-response

Reference this group by using

{
  "$ref": "v2.json#/definitions/start-response"
}

starter

the current definition of the starter: may change during multi-step starters

starter

is required
Type: object (Starter)
cannot be null
defined in:

starter Type

object (Starter)

any of

all of
- Starter Metadata
- Starter with Files
all of
- all of
  - Starter Metadata
  - Starter with Files
all of
- Starter Metadata
all of
- Starter Metadata
- Starter with Files

status

the current state of the Starter

status

is required
Type: string (Status)
cannot be null
defined in:

status Type

string (Status)

status Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
`"error"`
`"continuing"`
`"done"`

name

the canonical name of the starter

name

is required
Type: string (Name)
cannot be null
defined in:

name Type

string (Name)

body

user data populated by the client

body

is required
Type: object (Body)
cannot be null
defined in:

body Type

object (Body)

path

the API path (/ delimited) to which files will be written

path

is required
Type: string (API Path)
cannot be null
defined in:

path Type

string (API Path)

copy

copy files after starter is run (irrespective of status) if true

copy

is optional
Type: boolean (Force Copy)
cannot be null
defined in:

copy Type

boolean (Force Copy)

errors

a listing of system and user errors created during a starter

errors

is optional
Type: string[] (Error Text)
cannot be null
defined in:

errors Type

string[] (Error Text)

Definitions group starter

Reference this group by using

{
  "$ref": "v2.json#/definitions/starter"
}

type

type

is required
Type: string (Starter Type)
cannot be null
defined in:

type Type

string (Starter Type)

Definitions group starter-meta

Reference this group by using

{
  "$ref": "v2.json#/definitions/starter-meta"
}

label

human-readable, plain-text description used in UI labels and tab titles

label

is required
Type: string (Label)
cannot be null
defined in:

label Type

string (Label)

description

short, plain-text description of the intent of the Starter

description

is required
Type: string (Description)
cannot be null
defined in:

description Type

string (Description)

icon

SVG string to use in Launcher cards and tab icons

icon

is optional
Type: string (Icon)
cannot be null
defined in:

icon Type

string (Icon)

commands

JupyterLab commands to run after the Starter has completed

commands

is optional
Type: object[] (JupyterLab Command)
cannot be null
defined in:

commands Type

object[] (JupyterLab Command)

ignore

glob-style patterns for folders and files exclude from copying, with * for wildcards

ignore

is optional
Type: string[]
cannot be null
defined in:

ignore Type

string[]

schema

Draft 7 JSON Schema that generates a form like this one, which must validate the user’s data. Description fields may include markdown

schema

is optional
Type: object (JSON Schema)
cannot be null
defined in:

schema Type

object (JSON Schema)

uiSchema

react-jsonschema-form uiSchema for customizing the selection of widgets

uiSchema

is optional
Type: object (UI Schema)
cannot be null
defined in:

uiSchema Type

object (UI Schema)

Definitions group command

Reference this group by using

{
  "$ref": "v2.json#/definitions/command"
}

id

canonical name for the command

id

is required
Type: string (Command ID)
cannot be null
defined in:

id Type

string (Command ID)

args

optional values provided to the command when executed

args

is optional
Type: object (Arguments)
cannot be null
defined in:

args Type

object (Arguments)

Definitions group starter-copy

Reference this group by using

{
  "$ref": "v2.json#/definitions/starter-copy"
}

type

Signifies a copy type

type

is optional
Type: string (Copy Type)
cannot be null
defined in:

type Type

string (Copy Type)

type Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
`"copy"`

Definitions group starter-copy-with-dest

Reference this group by using

{
  "$ref": "v2.json#/definitions/starter-copy-with-dest"
}

dest

The file or folder to copy to: Jinja templates will be applied with body as the context

dest

is required
Type: string (Copy Destination)
cannot be null
defined in:

dest Type

string (Copy Destination)

Definitions group starter-notebook

Reference this group by using

{
  "$ref": "v2.json#/definitions/starter-notebook"
}

type

Signifies a notebook starter

type

is optional
Type: string (Notebook Type)
cannot be null
defined in:

type Type

string (Notebook Type)

type Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
`"notebook"`

Definitions group starter-python

Reference this group by using

{
  "$ref": "v2.json#/definitions/starter-python"
}

type

Signifies a python starter

type

is optional
Type: string (Python Type)
cannot be null
defined in:

type Type

string (Python Type)

type Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
`"python"`

callable

a python function that accepts the body

callable

is required
Type: string (Python Callable)
cannot be null
defined in:

callable Type

string (Python Callable)

callable Constraints

pattern: the string must match the following regular expression:

[a-zA-Z_\d\.]

Definitions group starter-with-src

Reference this group by using

{
  "$ref": "v2.json#/definitions/starter-with-src"
}

src

path to the starter. may be absolute or relative to the notebook launch directory (or py_src)

src

is required
Type: string (Starter Source)
cannot be null
defined in:

src Type

string (Starter Source)

py_src

name of a python module installed in the notebook environment to prepent to src

py_src

is optional
Type: string (Starter Python Source)
cannot be null
defined in:

py_src Type

string (Starter Python Source)