Starter Metadata Schema¶
v2.json#/definitions/starter-python/allOf/0
common metadata for Starters
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions |
|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none |
0 Type¶
object (Starter Metadata)
Starter Metadata Properties¶
| Property | Type | Required | Nullable |
|---|---|---|---|
| label | string |
Required | cannot be null |
| description | string |
Required | cannot be null |
| icon | string |
Optional | cannot be null |
| commands | array |
Optional | cannot be null |
| ignore | array |
Optional | cannot be null |
| schema | object |
Optional | cannot be null |
| uiSchema | object |
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
description¶
short, plain-text description of the intent of the Starter
description
is required
Type:
string(Description)cannot be null
description Type¶
string (Description)
icon¶
SVG string to use in Launcher cards and tab icons
icon
is optional
Type:
string(Icon)cannot be null
commands¶
JupyterLab commands to run after the Starter has completed
commands
is optional
Type:
object[](JupyterLab Command)cannot be null
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
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
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