Sprint report

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

Sprint report localization data categories

https://gros.liacs.nl/schema/sprint-report/categories.json

categories

categories

type	array
items	type	object
	properties
	icon	Portions of a FontAwesome icon class that indicates the category.
		type	array
		items	type	string
		minItems	2
	items	Features belonging to the category.
		type	array
		items	type	string
	name	Identifier of the category.
		type	string
	patternProperties
	^[a-zA-Z]{2,3}(-.*)?$	Category name 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	string

Sprint report configuration

https://gros.liacs.nl/schema/sprint-report/config.json

config-visualization

Sprint report project features details

https://gros.liacs.nl/schema/sprint-report/details.json

sprint-report-project-details

sprint-report-project-details

type	object
patternProperties
^.+$	sprint-report-feature-details

sprint-report-feature-details

type	object
patternProperties
^[0-9]+$	sprint-report-sprint-details

sprint-report-sprint-details

type	object
patternProperties
^.+$	type	array
	items	oneOf	type	number
			type	string

Sprint report data expressions

https://gros.liacs.nl/schema/sprint-report/expressions.json

expressions

expressions

type	object
patternProperties
.*	type	object
	properties
	expression	Expression that is used to assign the generated feature.
		type	string
	attributes	type	array
		items	Feature used in an assignment of the generated feature.
			type	string

Sprint report metadata features

https://gros.liacs.nl/schema/sprint-report/features.json

sprint-report-features

sprint-report-features

type	object
properties
default	Features to display by default.
	feature_list
all	Features that are available to display.
	feature_list
future	Features that have predictions for future sprints.
	feature_list
details	Features that have unit-level details on how their were extracted.
	feature_list
metrics	Features that are based on quality metrics.
	feature_list
meta	Features that are available as metadata in the report.
	feature_list

feature_list

type	array
items	type	string

Sprint report feature details

https://gros.liacs.nl/schema/sprint-report/feature_details.json

sprint-report-feature-details

Sprint report data metric targets

https://gros.liacs.nl/schema/sprint-report/metrics_targets.json

metric_targets

metric_targets

type	object
patternProperties
^.+$	type	array

metric_target

type	object
properties
direction	Whether the metric improves if the value increases. true if a higher value is better, false if a lower value is better.
	type	boolean
perfect	Perfect value of the metric.
	type	number
target	Target value of the metric.
	type	number
low_target	Low target value of the metric.
	type	number
date	Moment when the metric targets were changed.
	type	string
	pattern	^[0-9][0-9][0-9][0-9]-[0-9][0-9]-[0-9][0-9] [0-9][0-9]:[0-9][0-9]:[0-9][0-9]$

Sprint report project feature sprints

https://gros.liacs.nl/schema/sprint-report/project_feature.json

sprint-report-project-feature

sprint-report-project-feature

type	array
items	sprint-report-feature

Sprint report project features

https://gros.liacs.nl/schema/sprint-report/project_features.json

sprint-report-project-features

sprint-report-project-features

type	array
items	type	object
	properties
	sprint_name	Name of the sprint.
		type	string
	patternProperties
	^(?!sprint_name$).+$	sprint-report-feature

sprint-report-feature

oneOf	sprint-report-feature-number
	sprint-report-feature-date
	sprint-report-feature-range

sprint-report-feature-number

oneOf	type	number
	type	string
	const	NA

sprint-report-feature-date

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]$

sprint-report-feature-range

type	object
properties
min	sprint-report-feature-number
max	sprint-report-feature-number

Sprint report source age

https://gros.liacs.nl/schema/sprint-report/source_ids.json

sprint-report-source-age

sprint-report-source-age

type	object
patternProperties
^(project | metric_history | metric_options | quality_time | quality | sonar | jenkins | jira | vcs | git | gitlab | github | tfs | subversion | prediction)$	type	object
	properties
	date	Moment when the latest update took place for the source. This may also be an invalid date if the date could not be retrieved.
		type	string
	url	URL of the source, specifically for the project and potentially a direct link to the file that is used as the entry point of the source data.
		type	string
		format	uri

Sprint report source identifiers

https://gros.liacs.nl/schema/sprint-report/source_ids.json

sprint-report-source-ids

sprint-report-source-ids

type	object
patternProperties
^.+$	type	array
	items	type	object
		properties
		url	URL to the source where the source ID is extracted from.
			type	string
			format	uri
		source_id	Identifier of an artifact available at the source.
			type	string
		source_type	Type of the source.
			type	string

Sprint report metadata sprints

https://gros.liacs.nl/schema/sprint-report/sprints.json

sprint-report-sprints

sprint-report-sprints

type	object
properties
limit	Default number of sprints to show.
	type	number
	minimum	1
closed	Whether only sprints that have ended are part of the report.
	type	boolean
old	Whether more sprints than the limit are available.
	type	boolean
future	Number of sprints that are available for predictions.
	type	number
	minimum	0