Timeline¶
These schemas specify how the Timeline visualization is configured and how the data used by the visualization is formatted.
Timeline boards data¶
boards¶
type |
object |
||
patternProperties |
|||
|
oneOf |
type |
null |
type |
number |
||
minimum |
0 |
Timeline configuration¶
config¶
type |
object |
|
properties |
||
|
type |
string |
pattern |
^[a-zA-Z]{2,3}(-.*)?$ |
|
|
type |
string |
format |
uri |
|
allOf |
Timeline data summary¶
data¶
type |
object |
||
properties |
|||
|
Earliest date and time from all data sources. |
||
|
Latest date and time from all data sources. |
||
|
Moment when data was collected. |
||
|
Project names. |
||
type |
array |
||
items |
type |
string |
datetime¶
type |
string |
pattern |
^[1-9][0-9][0-9][0-9]-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])T[0-9][0-9]:[0-9][0-9]:[0-9][0-9]$ |
Timeline event data¶
event¶
type |
object |
patternProperties |
|
|
events¶
type |
array |
||
items |
type |
object |
|
properties |
|||
|
Project name of the event. |
||
type |
string |
||
|
Identifier of the sprint in which the event took place. |
||
type |
integer |
||
minimum |
0 |
||
|
Name of the sprint in which the event took place. |
||
type |
string |
||
|
Date and time that the event took place. |
||
|
Event type. |
||
type |
string |
||
|
Date and time that the event ends. |
||
|
Identifier of the Jira board that the event comes from. |
||
type |
integer |
||
minimum |
0 |
Timeline features data¶
timeline-features¶
type |
object |
||||||
patternProperties |
|||||||
|
oneOf |
||||||
type |
object |
||||||
patternProperties |
|||||||
|
oneOf |
||||||
type |
object |
||||||
patternProperties |
|||||||
|
oneOf |
||||||
type |
number |
||||||
additionalProperties |
False |
missing_data¶
type |
array |
|
items |
type |
null |
maxItems |
1 |
|
minItems |
1 |
nan¶
type |
string |
enum |
NA, NaN |
Timeline links data¶
links¶
type |
object |
||
patternProperties |
|||
|
type |
object |
|
properties |
|||
|
type |
string |
|
format |
uri |
Timeline project event data¶
Timeline sprint burndown data¶
sprint_burndown¶
type |
array |
||
items |
type |
object |
|
properties |
|||
|
Moment when the burndown chart changes. |
||
|
Difference in story points at the change of the burndown chart. |
||
type |
number |
||
|
Type of change to the burndown chart. - initial: Sprint start - scope_add: Scope change due to story addition - scope_remove: Scope change due to story removal - points: Story points change during sprint - completed: Story done - close: Sprint close |
||
type |
string |
||
enum |
initial, scope_add, scope_remove, points, completed, close |
burndown_datetime¶
type |
string |
pattern |
^[1-9][0-9][0-9][0-9]-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1]) [0-9][0-9]:[0-9][0-9]:[0-9][0-9]\.[0-9]{6}$ |
Timeline event types data¶
timeline-types¶
type |
array |
||||
items |
type |
object |
|||
properties |
|||||
|
type |
string |
|||
|
type |
object |
|||
patternProperties |
|||||
|
Localization for a specific language. Valid languages use two-letter ISO 639-1 language codes plus optional BCP 47 subtags, so only a subset of languages is recognized. |
||||
type |
array |
||||
items |
type |
string |
|||
|
Whether to display the event by default. |
||||
type |
boolean |
||||
|
Whether to display the event data in a subchart per sprint instead of the main chart. |
||||
type |
boolean |