Jupyter Starters JSON Schema¶
https://raw.githubusercontent.com/deathbeds/jupyterlab-starters/master/src/jupyter_starters/schema/v2.json
A collection of JSON types for configuring and operating Starters
Abstract |
Extensible |
Status |
Identifiable |
Custom Properties |
Additional Properties |
Access Restrictions |
Defined In |
---|---|---|---|---|---|---|---|
Cannot be instantiated |
Yes |
Unknown status |
Unknown identifiability |
Forbidden |
Allowed |
none |
v2.json |
Jupyter Starters JSON Type¶
object
(Jupyter Starters JSON)
any of
Jupyter Starters JSON Definitions¶
Definitions group all-starters¶
Reference this group by using
{
"$ref": "https://raw.githubusercontent.com/deathbeds/jupyterlab-starters/master/src/jupyter_starters/schema/v2.json#/definitions/all-starters"
}
Property |
Type |
Required |
Nullable |
Defined by |
---|---|---|---|---|
|
Required |
cannot be null |
||
|
Optional |
cannot be null |
||
|
Required |
cannot be null |
starters¶
a named set of Starters
starters
is required
Type:
object
(Starters)cannot be null
defined in: Jupyter Starters JSON
starters Type¶
object
(Starters)
running¶
Starters currently using a process/resource
running
is optional
Type:
string[]
cannot be null
defined in: Jupyter Starters JSON
running Type¶
string[]
version¶
The version of the Jupyter Starters API
version
is required
Type:
string
(API Version)cannot be null
defined in: Jupyter Starters JSON
version Type¶
string
(API Version)
version Constraints¶
enum: the value of this property must be equal to one of the following values:
Value |
Explanation |
---|---|
|
Definitions group starters¶
Reference this group by using
{
"$ref": "https://raw.githubusercontent.com/deathbeds/jupyterlab-starters/master/src/jupyter_starters/schema/v2.json#/definitions/starters"
}
Property |
Type |
Required |
Nullable |
Defined by |
---|---|---|---|---|
Additional Properties |
Merged |
Optional |
cannot be null |
Additional Properties¶
Additional properties are allowed, as long as they follow this schema:
is optional
Type:
object
(Starter)cannot be null
defined in: Jupyter Starters JSON
additionalProperties Type¶
object
(Starter)
any of
all of
all of
all of
all of
Definitions group start-response¶
Reference this group by using
{
"$ref": "https://raw.githubusercontent.com/deathbeds/jupyterlab-starters/master/src/jupyter_starters/schema/v2.json#/definitions/start-response"
}
Property |
Type |
Required |
Nullable |
Defined by |
---|---|---|---|---|
Merged |
Required |
cannot be null |
||
|
Required |
cannot be null |
||
|
Required |
cannot be null |
||
|
Required |
cannot be null |
||
|
Required |
cannot be null |
||
|
Optional |
cannot be null |
||
|
Optional |
cannot be null |
starter¶
the current definition of the starter: may change during multi-step starters
starter
is required
Type:
object
(Starter)cannot be null
defined in: Jupyter Starters JSON
starter Type¶
object
(Starter)
any of
all of
all of
all of
all of
status¶
the current state of the Starter
status
is required
Type:
string
(Status)cannot be null
defined in: Jupyter Starters JSON
status Type¶
string
(Status)
status Constraints¶
enum: the value of this property must be equal to one of the following values:
Value |
Explanation |
---|---|
|
|
|
|
|
name¶
the canonical name of the starter
name
is required
Type:
string
(Name)cannot be null
defined in: Jupyter Starters JSON
name Type¶
string
(Name)
body¶
user data populated by the client
body
is required
Type:
object
(Body)cannot be null
defined in: Jupyter Starters JSON
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: Jupyter Starters JSON
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: Jupyter Starters JSON
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: Jupyter Starters JSON
errors Type¶
string[]
(Error Text)
Definitions group starter¶
Reference this group by using
{
"$ref": "https://raw.githubusercontent.com/deathbeds/jupyterlab-starters/master/src/jupyter_starters/schema/v2.json#/definitions/starter"
}
Property |
Type |
Required |
Nullable |
Defined by |
---|---|---|---|---|
|
Required |
cannot be null |
type¶
type
is required
Type:
string
(Starter Type)cannot be null
defined in: Jupyter Starters JSON
type Type¶
string
(Starter Type)
Definitions group starter-meta¶
Reference this group by using
{
"$ref": "https://raw.githubusercontent.com/deathbeds/jupyterlab-starters/master/src/jupyter_starters/schema/v2.json#/definitions/starter-meta"
}
Property |
Type |
Required |
Nullable |
Defined by |
---|---|---|---|---|
|
Required |
cannot be null |
||
|
Required |
cannot be null |
||
|
Optional |
cannot be null |
||
|
Optional |
cannot be null |
||
|
Optional |
cannot be null |
||
|
Optional |
cannot be null |
||
|
Optional |
cannot be null |
label¶
human-readable, plain-text description used in UI labels and tab titles
label
is required
Type:
string
(Label)cannot be null
defined in: Jupyter Starters JSON
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: Jupyter Starters JSON
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: Jupyter Starters JSON
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: Jupyter Starters JSON
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: Jupyter Starters JSON
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: Jupyter Starters JSON
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: Jupyter Starters JSON
uiSchema Type¶
object
(UI Schema)
Definitions group command¶
Reference this group by using
{
"$ref": "https://raw.githubusercontent.com/deathbeds/jupyterlab-starters/master/src/jupyter_starters/schema/v2.json#/definitions/command"
}
Property |
Type |
Required |
Nullable |
Defined by |
---|---|---|---|---|
|
Required |
cannot be null |
||
|
Optional |
cannot be null |
id¶
canonical name for the command
id
is required
Type:
string
(Command ID)cannot be null
defined in: Jupyter Starters JSON
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: Jupyter Starters JSON
args Type¶
object
(Arguments)
Definitions group starter-copy¶
Reference this group by using
{
"$ref": "https://raw.githubusercontent.com/deathbeds/jupyterlab-starters/master/src/jupyter_starters/schema/v2.json#/definitions/starter-copy"
}
Property |
Type |
Required |
Nullable |
Defined by |
---|---|---|---|---|
|
Optional |
cannot be null |
type¶
Signifies a copy type
type
is optional
Type:
string
(Copy Type)cannot be null
defined in: Jupyter Starters JSON
type Type¶
string
(Copy Type)
type Constraints¶
enum: the value of this property must be equal to one of the following values:
Value |
Explanation |
---|---|
|
Definitions group starter-copy-with-dest¶
Reference this group by using
{
"$ref": "https://raw.githubusercontent.com/deathbeds/jupyterlab-starters/master/src/jupyter_starters/schema/v2.json#/definitions/starter-copy-with-dest"
}
Property |
Type |
Required |
Nullable |
Defined by |
---|---|---|---|---|
|
Required |
cannot be null |
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: Jupyter Starters JSON
dest Type¶
string
(Copy Destination)
Definitions group starter-notebook¶
Reference this group by using
{
"$ref": "https://raw.githubusercontent.com/deathbeds/jupyterlab-starters/master/src/jupyter_starters/schema/v2.json#/definitions/starter-notebook"
}
Property |
Type |
Required |
Nullable |
Defined by |
---|---|---|---|---|
|
Optional |
cannot be null |
type¶
Signifies a notebook starter
type
is optional
Type:
string
(Notebook Type)cannot be null
defined in: Jupyter Starters JSON
type Type¶
string
(Notebook Type)
type Constraints¶
enum: the value of this property must be equal to one of the following values:
Value |
Explanation |
---|---|
|
Definitions group starter-python¶
Reference this group by using
{
"$ref": "https://raw.githubusercontent.com/deathbeds/jupyterlab-starters/master/src/jupyter_starters/schema/v2.json#/definitions/starter-python"
}
Property |
Type |
Required |
Nullable |
Defined by |
---|---|---|---|---|
|
Optional |
cannot be null |
||
|
Required |
cannot be null |
type¶
Signifies a python starter
type
is optional
Type:
string
(Python Type)cannot be null
defined in: Jupyter Starters JSON
type Type¶
string
(Python Type)
type Constraints¶
enum: the value of this property must be equal to one of the following values:
Value |
Explanation |
---|---|
|
callable¶
a python function that accepts the body
callable
is required
Type:
string
(Python Callable)cannot be null
defined in: Jupyter Starters JSON
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": "https://raw.githubusercontent.com/deathbeds/jupyterlab-starters/master/src/jupyter_starters/schema/v2.json#/definitions/starter-with-src"
}
Property |
Type |
Required |
Nullable |
Defined by |
---|---|---|---|---|
|
Required |
cannot be null |
||
|
Optional |
cannot be null |
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: Jupyter Starters JSON
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: Jupyter Starters JSON
py_src Type¶
string
(Starter Python Source)