Timeline

These schemas specify how the Timeline visualization is configured and how the data used by the visualization is formatted.

Timeline boards data

https://gros.liacs.nl/schema/timeline/boards.json

boards

boards

type

object

patternProperties

  • ^.+$

oneOf

type

null

type

number

minimum

0

Timeline configuration

https://gros.liacs.nl/schema/timeline/config.json

config

config

type

object

properties

  • language

type

string

pattern

^[a-zA-Z]{2,3}(-.*)?$

  • jira_url

type

string

format

uri

allOf

config-visualization

Timeline data summary

https://gros.liacs.nl/schema/timeline/data.json

data

data

type

object

properties

  • min_date

Earliest date and time from all data sources.

datetime

  • max_date

Latest date and time from all data sources.

datetime

  • update_date

Moment when data was collected.

datetime

  • projects

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

https://gros.liacs.nl/schema/timeline/event.json

event

event

type

object

patternProperties

  • ^.+$

events

events

type

array

items

type

object

properties

  • project_name

Project name of the event.

type

string

  • sprint_id

Identifier of the sprint in which the event took place.

type

integer

minimum

0

  • sprint_name

Name of the sprint in which the event took place.

type

string

  • date

Date and time that the event took place.

datetime

  • type

Event type.

type

string

  • end_date

Date and time that the event ends.

datetime

  • board_id

Identifier of the Jira board that the event comes from.

type

integer

minimum

0

Timeline features data

https://gros.liacs.nl/schema/timeline/features.json

timeline-features

timeline-features

type

object

patternProperties

  • ^.+$

oneOf

missing_data

type

object

patternProperties

  • ^\d+$

oneOf

missing_data

type

object

patternProperties

  • ^.+$

oneOf

nan

type

number

additionalProperties

False

missing_data

type

array

items

type

null

maxItems

1

minItems

1

nan

type

string

enum

NA, NaN

Timeline project event data

https://gros.liacs.nl/schema/timeline/project_event.json

events

Timeline sprint burndown data

https://gros.liacs.nl/schema/timeline/sprint_burndow.json

sprint_burndown

sprint_burndown

type

array

items

type

object

properties

  • date

Moment when the burndown chart changes.

burndown_datetime

  • points

Difference in story points at the change of the burndown chart.

type

number

  • type

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

https://gros.liacs.nl/schema/timeline/types.json

timeline-types

timeline-types

type

array

items

type

object

properties

  • name

type

string

  • locales

type

object

patternProperties

  • ^[a-zA-Z]{2,3}(-.*)?$

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

  • enabled

Whether to display the event by default.

type

boolean

  • subchart

Whether to display the event data in a subchart per sprint instead of the main chart.

type

boolean