schema
stringclasses
471 values
key
stringlengths
0
203
description
stringlengths
0
4.37k
object
stringlengths
2
322k
specif-1.1.json
extends
Must be a member of resourceClasses.
{}
specif-1.1.json
propertyClasses
A list of keys referencing propertyClasses; a base resourceClass must have at least one propertyClass, whereas an extending class may have none.
{}
specif-1.1.json
extends
Must be a member of statementClasses.
{}
specif-1.1.json
isUndirected
Indicates that an instance's subject and object are equivalent and can be exchanged without change in meaning.
{"type": "boolean"}
specif-1.1.json
propertyClasses
A list of keys referencing propertyClasses; a statementClass may exist without propertyClasses.
{}
specif-1.1.json
subjectClasses
A list of keys referencing eligible resource and statement classes for a statement's subject; if missing, all resource or statement classes are eligible.
{}
specif-1.1.json
objectClasses
A list of keys referencing eligible resource and statement classes for a statement's object; if missing, all resource or statement classes are eligible.
{}
specif-1.1.json
class
Must be a member of 'propertyClasses'. In addition, it must be listed in the propertyClasses of the respective resource's or statement's (or any of it's parent's) class.
{}
specif-1.1.json
SpecifProperties
A list of properties of a resource or statement; the number of properties including any parent's properties must be >0.
{"type": "array", "uniqueItems": true, "items": {}}
specif-1.1.json
class
Must be a member of resourceClasses.
{}
specif-1.1.json
language
An IETF language tag such as 'en', 'en-US, 'fr' or 'de' showing the used language of the resource. Is superseded by a property's language value.
{"type": "string"}
specif-1.1.json
class
Must be a member of statementClasses.
{}
specif-1.1.json
language
An IETF language tag such as 'en', 'en-US, 'fr' or 'de' showing the used language of the statement. Is superseded by a property's language value.
{"type": "string"}
specif-1.1.json
subject
Must be a member of resources or statements.
{}
specif-1.1.json
object
Must be a member of resources or statements.
{}
specif-1.1.json
properties
If there is no title property, the statementClass' title applies.
{}
specif-1.1.json
title
The node's label; if missing, the value of the referenced resource's title property is applied.
{}
specif-1.1.json
resource
The pointer to the resource to be displayed at this position.
{}
specif-1.1.json
nodes
The next hierarchy level.
{}
specif-1.1.json
SpecifNodes
A list of pointers to resources; may be nested forming a tree, i.e. a hierarchy of pointers.
{"type": "array", "uniqueItems": true, "items": {}}
specif-1.1.json
title
The file's name.
{"type": "string"}
specif-1.1.json
url
An absolute or relative URL to the file; will be of format 'uri-reference' in future. If missing, the title applies.
{"type": "string"}
specif-1.1.json
type
The file's media type (formerly MIME-type) according to https://www.iana.org/assignments/media-types/media-types.xhtml.
{"type": "string"}
specif-1.1.json
$schema
An absolute URL pointing to this SpecIF schema. Supports both specif.de and schemastore.org.
{"type": "string", "format": "uri", "pattern": "^https?:\\/\\/(specif\\.de\\/v1\\.1\\/schema|json\\.schemastore\\.org\\/specif-1\\.1)\\.json$"}
specif-1.1.json
title
The project's name; if missing, the first hierarchy node's title applies.
{}
specif-1.1.json
description
The project's description; if missing, the first hierarchy node's description applies.
{}
specif-1.1.json
isExtension
Indicates that the project is not schema-compliant on its own; by default the value is 'false'. Of course, it is expected that once extended the project is schema-compliant.
{"type": "boolean"}
specif-1.1.json
language
An IETF language tag such as 'en', 'en-US, 'fr' or 'de' showing the used language of the project. Is superseded by a resource's, statement's or property's language value. By default, 'en' is assumed.
{"type": "string"}
specif-1.1.json
dataTypes
The base data types for use by property class definitions.
{"type": "array", "uniqueItems": true, "items": {}}
specif-1.1.json
propertyClasses
Class definition of a property for resources or statements. Is a sub-element of the respective resourceClass or statementClass. If no revision or change information is specified, the respective values of the parent element apply.
{"type": "array", "uniqueItems": true, "items": {}}
specif-1.1.json
resourceClasses
The class definitions for resources.
{"type": "array", "uniqueItems": true, "items": {}}
specif-1.1.json
statementClasses
The class definitions for statements in subject-predicate-object statements, where subject and object are resources.
{"type": "array", "uniqueItems": true, "items": {}}
specif-1.1.json
resources
The resources such as diagrams, model elements or requirements.
{"type": "array", "uniqueItems": true, "items": {}}
specif-1.1.json
statements
Subject-predicate-Object statements, where subject and object are resources. In other terms, statements are directed relations between two resources building a semantic net.
{"type": "array", "uniqueItems": true, "items": {}}
specif-1.1.json
hierarchies
A list of hierarchies with pointers to resources; may be nested to build a tree, i.e. a hierarchy of pointers.
{}
specif-1.1.json
files
A list of files being referenced by a resource's or statement's property of dataType XHTML using an <object> tag. A file should have a media type as defined by IANA (see below).
{"type": "array", "uniqueItems": true, "items": {}}
tson.json
tunings
List of tuning objects
{"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "object", "properties": {"name": {"type": "string"}, "id": {"type": "string"}, "scales": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"notes": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"oneOf": [...
tson.json
name
The tuning's name
{"type": "string"}
tson.json
description
A description of the tuning
{"type": "string"}
tson.json
id
A unique identifier for the tuning
{"type": "string"}
tson.json
scales
List of scale objects
{"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"notes": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"oneOf": [{"type": "object", "properties": {"frequency ratio": {"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$"}, {"type":...
tson.json
notes
A list of the scale's notes
{"type": "array", "minItems": 1, "uniqueItems": true, "items": {"oneOf": [{"type": "object", "properties": {"frequency ratio": {"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$"}, {"type": "number"}]}, "ratio": {"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*...
tson.json
frequency ratio
The note's frequency ratio
{"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$"}, {"type": "number"}]}
tson.json
ratio
The note's frequency ratio
{"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$"}, {"type": "number"}]}
tson.json
name
The note's name
{"type": "string"}
tson.json
items
The note's frequency ratio
{"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$"}, {"type": "number"}]}
tson.json
reference
A reference frequency that is used to map the note's frequency ratios to real frequencies values (ie., in Hz). Can be either a number (optionally appended with " Hz") or an object containing a frequency and an optional note that references one of the note names from the scale's notes list. If no note name is provided, ...
{"type": "object", "properties": {"frequency": {"oneOf": [{"type": "number"}, {"type": "string", "pattern": "^(0*[1-9][0-9]*(\\.[0-9]+)?|0+\\.[0-9]*[1-9][0-9]*)( Hz)?$"}]}, "note": {"type": "string"}}, "required": ["frequency"], "additionalProperties": true}
tson.json
frequency
The reference frequency - a number, optionally with " Hz" appended
{"oneOf": [{"type": "number"}, {"type": "string", "pattern": "^(0*[1-9][0-9]*(\\.[0-9]+)?|0+\\.[0-9]*[1-9][0-9]*)( Hz)?$"}]}
tson.json
note
The name of the note that should be mapped onto the reference frequency
{"type": "string"}
tson.json
repeat ratio
The frequency ratio at which the scale's notes will repeat
{"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$"}, {"type": "number"}]}
tson.json
repeat
The frequency ratio at which the scale's notes will repeat
{"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$"}, {"type": "number"}]}
tson.json
max frequency
A maximum frequency for the scale. When mapping the scale's notes onto actual frequencies, notes from this scale will not be mapped above the provided frequency.
{"oneOf": [{"type": "number"}, {"type": "string", "pattern": "^(0*[1-9][0-9]*(\\.[0-9]+)?|0+\\.[0-9]*[1-9][0-9]*)( Hz)?$"}]}
tson.json
max
A maximum frequency for the scale. When mapping the scale's notes onto actual frequencies, notes from this scale will not be mapped above the provided frequency.
{"oneOf": [{"type": "number"}, {"type": "string", "pattern": "^(0*[1-9][0-9]*(\\.[0-9]+)?|0+\\.[0-9]*[1-9][0-9]*)( Hz)?$"}]}
tson.json
maximum
A maximum frequency for the scale. When mapping the scale's notes onto actual frequencies, notes from this scale will not be mapped above the provided frequency.
{"oneOf": [{"type": "number"}, {"type": "string", "pattern": "^(0*[1-9][0-9]*(\\.[0-9]+)?|0+\\.[0-9]*[1-9][0-9]*)( Hz)?$"}]}
tson.json
min frequency
A minimum frequency for the scale. When mapping the scale's notes onto actual frequencies, notes from this scale will not be mapped below the provided frequency.
{"oneOf": [{"type": "number"}, {"type": "string", "pattern": "^(0*[1-9][0-9]*(\\.[0-9]+)?|0+\\.[0-9]*[1-9][0-9]*)( Hz)?$"}]}
tson.json
minimum
A minimum frequency for the scale. When mapping the scale's notes onto actual frequencies, notes from this scale will not be mapped below the provided frequency.
{"oneOf": [{"type": "number"}, {"type": "string", "pattern": "^(0*[1-9][0-9]*(\\.[0-9]+)?|0+\\.[0-9]*[1-9][0-9]*)( Hz)?$"}]}
tson.json
min
A minimum frequency for the scale. When mapping the scale's notes onto actual frequencies, notes from this scale will not be mapped below the provided frequency.
{"oneOf": [{"type": "number"}, {"type": "string", "pattern": "^(0*[1-9][0-9]*(\\.[0-9]+)?|0+\\.[0-9]*[1-9][0-9]*)( Hz)?$"}]}
tson.json
spectrum
The spectrum of the tones that should be used for this tuning. This enables multiple, scale-dependent spectra to be used within a single tuning.
{"type": "string"}
tson.json
spectra
A list of spectrum objects
{"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "object", "properties": {"name": {"type": "string"}, "id": {"type": "string"}, "partial distribution": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "object", "properties": {"frequency ratio": {"oneOf": [{"type": "string",...
tson.json
name
The spectrum's name
{"type": "string"}
tson.json
description
A description of the spectrum
{"type": "string"}
tson.json
id
A unique identifier for the spectrum
{"type": "string"}
tson.json
partial distribution
A list of partials that should be used to reconstruct the spectrum
{"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "object", "properties": {"frequency ratio": {"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$"}, {"type": "number"}]}, "ratio": {"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(p...
tson.json
frequency ratio
The partial's frequency ratio
{"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$"}, {"type": "number"}]}
tson.json
ratio
The partial's frequency ratio
{"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$"}, {"type": "number"}]}
tson.json
amplitude weight
The partial's amplitude weight. This determines how much the partial contributes to the overall power (ie., loudness) of the reconstructed spectrum.
{"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$"}, {"type": "number"}]}
tson.json
weight
The partial's amplitude weight. This determines how much the partial contributes to the overall power (ie., loudness) of the reconstructed spectrum.
{"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$"}, {"type": "number"}]}
tson.json
partials
A list of partials that should be used to reconstruct the spectrum
{"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "object", "properties": {"frequency ratio": {"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$"}, {"type": "number"}]}, "ratio": {"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(p...
tson.json
frequency ratio
The partial's frequency ratio
{"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$"}, {"type": "number"}]}
tson.json
ratio
The partial's frequency ratio
{"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$"}, {"type": "number"}]}
tson.json
amplitude weight
The partial's amplitude weight. This determines how much the partial contributes to the overall power (ie., loudness) of the reconstructed spectrum.
{"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$"}, {"type": "number"}]}
tson.json
weight
The partial's amplitude weight. This determines how much the partial contributes to the overall power (ie., loudness) of the reconstructed spectrum.
{"oneOf": [{"type": "string", "pattern": "^([1234567890.,+\\-*/^%()e ]|(pi)|(tau)|(abs)|(log))+$"}, {"type": "number"}]}
tson.json
sets
A list of set objects
{"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "object", "properties": {"id": {"type": "string"}, "name": {"type": "string"}, "members": {"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"tuning": {"type": "string"}, "spectrum": {"type": "string"}, "override scale spec...
tson.json
id
A unique identifier for the set
{"type": "string"}
tson.json
name
The set's name
{"type": "string"}
tson.json
description
A description of the set
{"type": "string"}
tson.json
members
A list of set member objects
{"type": "array", "minItems": 1, "items": {"type": "object", "properties": {"tuning": {"type": "string"}, "spectrum": {"type": "string"}, "override scale spectra": {"type": "boolean"}}, "additionalProperties": true}}
tson.json
tuning
A reference of a tuning's ID
{"type": "string"}
tson.json
spectrum
A reference of a spectrum's ID
{"type": "string"}
tson.json
override scale spectra
If true, the set's spectrum should be applied to all scales in the set's tuning, overriding any spectra that are references by the scales.
{"type": "boolean"}
config_schema.json
Taskcat configuration file
{"$schema": "http://json-schema.org/draft-06/schema#", "additionalProperties": false, "definitions": {"GeneralConfig": {"additionalProperties": false, "properties": {"artifact_regions": {"items": {"examples": ["us-east-1"], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southw...
config_schema.json
GeneralConfig
General configuration settings.
{"additionalProperties": false, "properties": {"artifact_regions": {"items": {"examples": ["us-east-1"], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string"}, "type": "array"}, "auth": {"additionalProperties": {"type": "strin...
config_schema.json
artifact_regions
List of AWS regions where artifacts need to be copied. This helps same region artifact bucket access to resources
{"items": {"examples": ["us-east-1"], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string"}, "type": "array"}
config_schema.json
items
AWS Region name
{"examples": ["us-east-1"], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string"}
config_schema.json
auth
AWS authentication section
{"additionalProperties": {"type": "string"}, "examples": [{"cn-northwest-1": "china-profile", "default": "my-default-profile", "us-east-2": "specific-profile-for-us-east-2"}], "type": "object"}
config_schema.json
parameters
Parameter key-values to pass to CloudFormation, parameters provided in global config take precedence
{"additionalProperties": {"anyOf": [{"items": {"anyOf": [{"type": "integer"}, {"type": "string"}]}, "type": "array"}, {"type": "boolean"}, {"type": "integer"}, {"type": "string"}]}, "type": "object"}
config_schema.json
posthooks
hooks to execute after executing tests
{"items": {}, "type": "array"}
config_schema.json
prehooks
hooks to execute prior to executing tests
{"items": {}, "type": "array"}
config_schema.json
regions
List of AWS regions
{"items": {"examples": ["us-east-1"], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string"}, "type": "array"}
config_schema.json
items
AWS Region name
{"examples": ["us-east-1"], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string"}
config_schema.json
s3_bucket
Name of S3 bucket to upload project to, if left out a bucket will be auto-generated
{"examples": ["my-s3-bucket-name"], "type": "string"}
config_schema.json
s3_regional_buckets
Enable regional auto-buckets.
{"examples": [true, false], "type": "boolean"}
config_schema.json
tags
Tags to apply to CloudFormation template
{"additionalProperties": {"type": "string"}, "examples": [{"CostCenter": "1001"}], "type": "object"}
config_schema.json
HookData
Hook definition
{"additionalProperties": false, "properties": {"config": {"type": "object"}, "type": {"type": "string"}}, "type": "object"}
config_schema.json
config
hook configuration
{"type": "object"}
config_schema.json
type
hook type
{"type": "string"}
config_schema.json
ProjectConfig
Project specific configuration section
{"additionalProperties": false, "properties": {"artifact_regions": {"items": {"examples": ["us-east-1"], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string"}, "type": "array"}, "auth": {"additionalProperties": {"type": "strin...
config_schema.json
artifact_regions
List of AWS regions where artifacts need to be copied. This helps same region artifact bucket access to resources
{"items": {"examples": ["us-east-1"], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string"}, "type": "array"}
config_schema.json
items
AWS Region name
{"examples": ["us-east-1"], "pattern": "^(ap|eu|us|sa|ca|cn|af|me|il|us-gov)-(central|south|north|east|west|southeast|southwest|northeast|northwest)-[0-9]$", "type": "string"}
config_schema.json
auth
AWS authentication section
{"additionalProperties": {"type": "string"}, "examples": [{"cn-northwest-1": "china-profile", "default": "my-default-profile", "us-east-2": "specific-profile-for-us-east-2"}], "type": "object"}