Visualization site

These schemas define configuration for the hub and the visualizations available in it.

Visualization site configuration

https://gros.liacs.nl/schema/visualization-site/config.json

config-visualization-site

config-base

Configuration common to all visualizations and the hub.
type	object
properties
visualization_url	type	string
	format	uri-reference

config-visualization-site

Configuration items of the visualization site.
type	object
properties
prediction_url	type	string
	format	uri-reference
blog_url	type	string
	format	uri-reference
discussion_url	type	string
	format	uri-reference
download_url	type	string
	format	uri-reference
jira_url	type	string
	format	uri-reference
blog_host	type	string
	format	hostname
blog_server	type	string
	format	hostname
discussion_host	type	string
	format	hostname
discussion_server	type	string
	format	hostname
www_server	type	string
	format	hostname
prediction_server	type	string
	format	hostname
hub_organizations	type	array
	items	hub_organization
hub_regex	type	string
	format	regex
hub_mapping	type	object
	properties
	hub	hub_map
	visualization	hub_map
	prediction	hub_map
branch_maps_path	type	string
hub_redirect	type	string
hub_branch	type	string
visualization_branch	type	string
prediction_branch	type	string
jenkins_host	type	string
	format	hostname
jenkins_path	type	string
jenkins_direct	type	string
jenkins_direct_url	type	string
	format	uri
jenkins_direct_cert	type	string
jenkins_api_token	type	string
files_host	type	string
	format	hostname
files_share_id	type	string
control_host	type	string
	format	hostname
websocket_server	type	string
	format	hostname
proxy_nginx	type	boolean
proxy_range	type	string
proxy_port_in_redirect	type	boolean
auth_cert	type	string
allow_range	type	array
	items	type	string
goaccess_path	type	string
goaccess_log_path	type	string
primary_dns	type	string
	oneOf	format	ipv4
		format	ipv6
allOf	config-base

hub_organization

Organization properties to make a hub available for.
type	object
properties
organization	type	string
	pattern	^[-_0-9a-zA-Z]+$
title	navbar_locale
locale	navbar_locale
image	type	string
width	type	integer
	minimum	0
height	type	integer
	minimum	0
style	type	string
url	type	string
	format	uri
visualization-site	type	string
	pattern	^[-_0-9a-zA-Z]+$
prediction-site	type	string
	pattern	^[-_0-9a-zA-Z]+$
visualizations	type	array
	items	type	string

hub_map

Mapping from URL parts to branch names.
type	object
patternProperties
^[_a-z]+$	type	object
	properties
	input	type	string
	default	type	string
	output	type	object
		patternProperties
		.+	type	string
			minLength	1
unevaluatedProperties	False

navbar_locale

type	object
patternProperties
^[a-zA-Z]{2,3}(-.*)?$	Localization item 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

config-visualization

Base configuration for visualizations.
type	object
properties
path	type	string
allOf	config-base

Visualization test schema samples

https://gros.liacs.nl/schema/visualization-site/samples.json

samples

samples

type	object
patternProperties
^.+$	Path to schema file that describes the format of the sample file(s) available at the glob path key.
	type	string

Available visualizations on visualization site

https://gros.liacs.nl/schema/visualization-site/visualizations.json

visualizations

visualizations

type	object
properties
groups	type	array
	items	group

group

Group of visualizations to be shown together in the hub.
type	object
properties
id	Identifier of the group.
	type	string
items	type	array
	items	visualization

visualization

Visualization available in the hub.
type	object
properties
id	Identifier of the visualization.
	type	string
icon	FontAwesome specification for an icon that represents the visualization.
	type	array
	minItems	2
url	Mustache template for a URL to the visualization. Uses the ID in combination with visualization_url configuration if not provided.
	type	string
language_parameter	Query string parameter key to use to add the currently selected language in the URL to the visualization.
	type	string
blog	Reference to a blog post about the visualization.
	type	object
	properties
	fragment	URL fragment for the blog post.
		type	string
	language	Language code for the language the blog post is written in.
		type	string
download	Custom download URL for the visualization.
	type	string
nginx	Whether the visualization is hosted by the proxy on the visualization site. This is false when the visualization is hosted on another site, such as the prediction site.
	type	boolean
index	Whether to display the visualization as a block on the visualization site hub.
	type	boolean
repo	Name of the repository where the code for the visualization is stored.
	type	string
videos	type	array
	items	JSON-LD specification of a video about the visualization.
		type	object
		properties
		@type	JSON-LD type of the video object.
			type	string
			const	VideoObject
		@id	Path to the video file.
			type	string
			format	uri-reference
		name	Title of the video.
			type	string
		thumbnail	Path to a thumbnail image of the video.
			type	string
			format	uri-reference
		duration	Duration of the video.
			type	string
			format	duration
		inLanguage	Language that the video is available in.
			type	string
			pattern	^[a-zA-Z]{2,3}(-.*)?$
		sameAs	External location where the video is available.
			type	string
			format	uri

Visualization metadata

These schemas are reusable specifications for localization and groups of features, projects and source information. Multiple visualizations make use of these formats to define translations and provide structured, navigable and traceable data.

Feature metadata

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

features-metadata

features-metadata

type	object
properties
values	features-values
measurement	features-measurement
preferred	type	object
	patternProperties
	.*	Whether the feature should be displayed prominently as a useful feature for tracking. When this is false, then the feature may be internal, used as a dependent feature for another feature, or more complicated than used simply in reports.
		type	boolean
prediction	features-prediction

features-values

type	object
patternProperties
.*	type	object
	properties
	type	The format type of a feature.
		type	string
		enum	fraction, duration, icon
	denominator	The maximum denominator to be used when formatting a value of a feature with the fraction type.
		type	integer
		minimum	1
	intervals	type	array
		items	Interval specification for a feature with the duration type. Values of this feature can be formatted by dividing the value by the intervals, until the value is small enough.
			type	object
			properties
			unit	The interval unit size. The length of the interval is defined by num of this unit.
				moment_key
			key	The shorthand key for the interval unit.
				type	string
				enum	y, M, w, d, h, m, s
			num	The interval size.
				type	integer
				minimum	1
	icons	Icons to use in place of a value in order to format it for a feature with the icon type.
		type	object
		patternProperties
		^[0-9]+$	FontAwesome specification for an icon that represents the value.
			type	array
			minItems	2

features-measurement

type	object
patternProperties
.*	type	object
	properties
	unit	The type of unit that the feature describes. Potentially described in a (recursive) fractional manner where terms have different units.
		measurement_unit
	dividend	Feature that is used (in part) in the numerator of a unit fraction in order to end up with this feature.
		measurement_unit
	divisor	Feature that is used (in part) in the denominator of a unit fraction in order to end up with this feature.
		measurement_unit
	superset	Feature that represents a wider number of the same unit compared to this feature.
		type	string
	moment	Indicator of when the feature is measured compared to the sprint. post means that the value is only complete once the sprint is ended.
		oneOf	type	array
			items	oneOf	type	integer
					type	string
			maxItems	2
			minItems	2
			type	string
			enum	post
	pre	Feature that indicates a value at the start of a sprint that is related to this feature, and could be used to compare progress during the sprint.
		type	string

features-prediction

type	object
patternProperties
.*	Different methods of predicting the feature.
	type	array
	items	type	object
		properties
		url	Template for a URL to retrieve prediction data values for this feature.
			type	string
		reference	Feature that can be used as a linear regression over sprints to predict the overall change of the feature.
			type	string
		monte_carlo	monte_carlo
	minItems	1

monte_carlo

Parameters for a Monte Carlo simulation to predict the feature.
type	object
properties
name	Name of the simulation.
	type	string
factors	type	array
	items	type	object
		properties
		column	Feature to use for the base factor.
			type	string
		multiplier	Feature to use as multiplication of the column feature.
			type	string
		scalar	Weight to apply to this factor.
			type	number
		prob	Probability density function.
			type	string
		params	Parameters for the probability density function.
			type	array
			items	type	number
		sample	Whether to use the probability function to select new random data. When this is missing or false, the actual data from the column feature is selected instead.
			type	boolean

moment_key

type	string
enum	years, months, weeks, days, hours, minutes, seconds

measurement_unit

oneOf	type	string
	type	array
	items	measurement_unit
	minItems	2

Localization data

https://gros.liacs.nl/schema/metadata/locale.json

Locales

Locales

type	object
patternProperties
^[a-zA-Z]{2,3}(-.*)?$	Localization items for a specific language, with keys and localized replacement values. Valid languages use two-letter ISO 639-1 language codes plus optional BCP 47 subtags, so only a subset of languages is recognized.
	type	object
	patternProperties
	.*	type	string

descriptions

Feature descriptions.

Locales

long_descriptions

Long feature descriptions.

Locales

predictor

Short feature descriptions when used as factors for a prediction of another feature, in order to differentiate prediction strategies.

Locales

tags

Feature tag names.

Locales

units

Feature unit format templates.

Locales

short_units

Feature shorthand unit format templates.

Locales

sources

Source names, icons and metadata.
type	object
properties
icon	type	object
	patternProperties
	.*	Portions of a FontAwesome icon class that indicates a source system.
		type	array
		items	type	string
		minItems	2
feature	type	object
	patternProperties
	.*	List of features that originate from the source system.
		type	array
		items	type	string
allOf	Locales

Projects list

https://gros.liacs.nl/schema/metadata/projects.json

projects

projects

type	array
items	type	string

Projects metadata

https://gros.liacs.nl/schema/metadata/projects_meta.json

projects_meta

projects_meta

type	array
items	project_meta

project_meta

Metadata for an individual project.
type	object
properties
name	Name of the project, usually a identifier key from an issue tracker.
	type	string
quality_display_name	Human-readable name of the project from the quality control dashboard.
	type	string
recent	Whether the project has recent sprints.
	type	boolean
core	Whether the project is considered to be an actual software development project. When false, the project is developed by a support team.
	type	boolean
main	Whether the project is a main project with no parent. When false, the project is a child of another.
	type	boolean
team	Indication that the project is the primary project of a team. If this is 0, then another project is the team’s main project. For values higher than 1, this also indicates the identifier of the board used by the team as an overview of the project.
	type	number
component	If the project is not a component of another project, then this is false, otherwise the filters used based on component names to generate the component.
	oneOf	type	boolean
		const	False
		component_filters
project_names	Identifiers of the projects used to generate the project or team.
	project_names
num_sprints	Number of sprints in the project.
	type	number
	minimum	0
future_sprints	Number of sprints in the future for the project with predictions for features.
	type	number
	minimum	0

project_names

oneOf	type	string
	type	array
	items	type	string
	minItems	2

component_filters

type	array
items	type	object
	properties
	include	type	string
	exclude	type	string
minItems	1

Sources for an individual project

https://gros.liacs.nl/schema/metadata/project_sources.json

project_sources

project_sources

type	object
patternProperties
.*	URL for a source, specifically for a project.
	type	string
	format	uri

Sources for projects

https://gros.liacs.nl/schema/metadata/projects_sources.json

projects_sources

projects_sources

type	object
patternProperties
.*	project_sources

Sources for an individual sprint

https://gros.liacs.nl/schema/metadata/sprint_sources.json

sprint_sources

sprint_sources

type	object
patternProperties
.*	type	object
	properties
	source	URL for the source, usually specifically for a sprint and feature, but sometimes broadly for the project.
		type	string
		format	uri
	type	Type of the source.
		type	string