Start Response Schema#
https://raw.githubusercontent.com/deathbeds/jupyterlab-starters/master/src/jupyter_starters/schema/v3.json#/definitions/start-response
Abstract |
Extensible |
Status |
Identifiable |
Custom Properties |
Additional Properties |
Access Restrictions |
Defined In |
---|---|---|---|---|---|---|---|
Can be instantiated |
No |
Unknown status |
No |
Forbidden |
Allowed |
none |
start-response Type#
object
(Start Response)
start-response Properties#
Property |
Type |
Required |
Nullable |
Defined by |
---|---|---|---|---|
|
Required |
cannot be null |
||
|
Optional |
cannot be null |
||
|
Optional |
cannot be null |
||
|
Required |
cannot be null |
||
|
Required |
cannot be null |
||
Merged |
Required |
cannot be null |
||
|
Required |
cannot be null |
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)
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)
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)
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)
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
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 |
---|---|
|
|
|
|
|