Schema URL

Type: object

The Specification Integration Facility (SpecIF) integrates partial system models from different methods and tools in a semantic net. Collaborators shall browse, search and audit engineering results in a common context. Also, the exchange of model information between organizations and tools is facilitated. SpecIF represents the visible, i.e. the diagrams and the text, as well as the semantics of system specifications.

Properties

$schema string required

An absolute URL pointing to this SpecIF schema.

format=uripattern=^https?:\/\/(specif\.de\/v1\.0\/schema|.+\/specif-1\.0)\.json$
id string required

A globally unique identifier.

pattern=^[_a-zA-Z]{1}[_a-zA-Z0-9.-]*$
title string | object[] required

A property value according to the property class.

resourceClasses object[] required

The class definitions for resources.

uniqueItems=true
statementClasses object[] required

The class definitions for statements in subject-predicate-object statements, where subject and object are resources.

uniqueItems=true
resources object[] required

The resources such as diagrams, model elements or requirements.

uniqueItems=true
statements object[] required

Subject-predicate-Object statements, where subject and object are resources. In other terms, statements are directed relations between two resources building a semantic net.

uniqueItems=true
hierarchies object[] required

A list of pointers to resources; may be nested to build a tree, i.e. a hierarchy of pointers.

uniqueItems=true
description string | object[]

A property value according to the property class.

isExtension boolean

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.

generator string
generatorVersion string
rights object
3 nested properties
title string required
type string required
url string required
format=uri
createdAt string

An ISO-8601 dateTime string. For reduced accuracy, any number of values may be dropped, but only from right to left.

format=date-time
createdBy object

The creator of the SpecIF data-set (file). If specified, at least an e-mail address must be given.

4 nested properties
email object required
2 nested properties
value string required
format=email
type string
familyName string
givenName string
org object
1 nested properties
organizationName string required
language string

An IETF language tag such as 'en', 'en-US, 'fr' or 'de' showing the used language of simple property values. Is superseded by a resource's, statement's or property's language value.

dataTypes object | object | object | object | object[]

The base data types for use by property class definitions.

uniqueItems=true
propertyClasses object[]

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.

uniqueItems=true
files object[]

A list of files being referenced by a resource's or statement's property of dataType XHTML using an tag. A file should have a media type as defined by IANA (see below).

uniqueItems=true

Definitions

id string

A globally unique identifier.

revision string

A globally unique revision tag with one or multiple blocks with alphanumeric characters separated by a special character [.:,;/-]. Sequential as well as branching/merging notations are possible.

replaces revision[]

For change and configuration management; the first revision has 0 entries, a simple modification has 1 entry and the result of a merge has 2 entries.

key id | object

A unique key for a particular revision of an identifiable item, e.g. of a resource.

dateTime string

An ISO-8601 dateTime string. For reduced accuracy, any number of values may be dropped, but only from right to left.

icon string

A symbol for display as a prefix to titles; applicable to all instances of the class. Is usually a XML-encoded UTF-8 symbol, can be an URL or dataURL.

instantiation string[]

Indicates whether an instance of the class is created automatically, manually or both. All is allowed, if the property is omitted. The class is abstract and cannot be instantiated, if the property list is present, but empty.

alternativeIds id | object[]

The list of consolidated items which can be used in case a consolidated item shall be updated.

value string | object[]

A property value according to the property class.

nodes object[]

A list of pointers to resources; may be nested to build a tree, i.e. a hierarchy of pointers.

properties object[]

A list of properties of a resource or statement.

Generated by Lintel Catalog Builder 0.0.16