description: The native URI of the element. This is always within the namespace of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri


key: deprecated

description: Description of why and when this element will no longer be used

type: string


description: When an element is deprecated, it can be automatically replaced by this uri or curie


description: When an element is deprecated, it can be potentially replaced by this uri or curie


key: description

description: a textual description of the element's purpose and use


description: True means that the key slot(s) is used to determine the instantiation (types) relation between objects and a ClassDefinition

type: boolean


description: Two classes are disjoint if they have no instances in common, two slots are disjoint if they can never hold between the same two instances

type: array


key: domain

description:
defines the type of the subject of the slot.  Given the following slot definition
  S1:
    domain: C1
    range:  C2
the declaration
  X:
    S1: Y

implicitly asserts that X is an instance of C1


description: the class(es) that reference the slot in a "slots" or "slot_usage" context


An inlined enumeration


description: the value of the slot must equal the value of the evaluated expression


description: the slot must have range of a number and the value of the slot must equal the specified value

type: integer


description: the slot must have range string and the value of the slot must equal the specified value


description: the slot must have range string and the value of the slot must equal one of the specified values


description: A list of terms from different schemas or terminology systems that have identical meaning.


description: holds if only one of the expressions hold


key: examples

description: example usages of an element


key: extensions

description: a tag/text tuple attached to an arbitrary element

type: object


description: id of the schema that defined the element


the value of the slot is multivalued with at least one member satisfying the condition


description: An allowed list of prefixes for which identifiers must conform. The identifier of this class or slot must begin with the URIs referenced by this prefix


key: identifier

description: True means that the key slot(s) uniquely identifies the elements. There can be at most one identifier or key per container


key: ifabsent

description:
function that provides a default value for the slot.  Possible values for this slot are defined in
linkml.utils.ifabsent_functions.default_library:
  * [Tt]rue -- boolean True
  * [Ff]alse -- boolean False
  * bnode -- blank node identifier
  * class_curie -- CURIE for the containing class
  * class_uri -- URI for the containing class
  * default_ns -- schema default namespace
  * default_range -- schema default range
  * int(value) -- integer value
  * slot_uri -- URI for the slot
  * slot_curie -- CURIE for the slot
  * string(value) -- string value


key: implements

description: An element in another schema which this element conforms to. The referenced element is not imported into the schema for the implementing element. However, the referenced schema may be used to check conformance of the implementing element.


description: Causes the slot value to be interpreted as a uriorcurie after prefixing with this string


description: the imports entry that this element was derived from.  Empty means primary source


description: the primary language used in the sources


description: used to indicate membership of a term in a defined subset of terms used for a particular domain or application.


key: inherited

description: true means that the *value* of a slot is inherited by subclasses


key: inlined

description: True means that keyed or identified slot appears in an outer structure by value.  False means that only the key or identifier for the slot appears within the domain, referencing a structure that appears elsewhere.


description: True means that an inlined slot is represented as a list of range instances.  False means that an inlined slot is represented as a dictionary, whose key is the slot key or identifier and whose value is the range instance.


key: instantiates

description: An element in another schema which this element instantiates.


key: inverse

description: indicates that any instance of d s r implies that there is also an instance of r s' d


key: irreflexive

description: If s is irreflexive, then there exists no i such i.s=i


description: A primary parent slot from which inheritable metaslots are propagated


description: indicates that for any instance, i, the domain of this slot will include an assertion of i s range


description: true if this slot is a grouping slot


description: True means that this slot was defined in a slot_usage situation


key: key

description: True means that the key slot(s) uniquely identify the elements within a single container


key: keywords

description: Keywords or tags used to describe the element


description: time at which the element was last updated

format: date-time


description: If True, then the order of elements of a multivalued slot is guaranteed to be preserved. If False, the order may still be preserved but this is not guaranteed


description: If True, then there must be no duplicates in the elements of a multivalued slot


key: additionalProperties

description: a name assigned to an element in a given ontology


description: If s is locally_reflexive, then i.s=i for all instances i where s is a class slot for the type of i


key: mappings

description: A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.


description: the maximum number of entries for a multivalued slot


description: for slots with ranges of type number, the value must be equal to or lowe than this


description: the minimum number of entries for a multivalued slot


description: for slots with ranges of type number, the value must be equal to or higher than this


key: mixin

description: Indicates the class or slot is intended to be inherited from without being an is_a parent. mixins should not be inherited from using is_a, except by other mixins.


key: mixins

description: A collection of secondary parent mixin slots from which inheritable metaslots are propagated


description: agent that modified the element


key: multivalued

description: true means that slot can have more than one value and should be represented using a list or collection structure.


key: name

description: the unique name of the element within the context of the schema.  Name is combined with the default prefix to form the globally unique subject of the target class.


description: A list of terms from different schemas or terminology systems that have narrower meaning.


description: holds if none of the expressions hold


key: notes

description: editorial notes about an element intended primarily for internal consumption


key: owner

description: the "owner" of the slot. It is the class if it appears in the slots list, otherwise the declaring slot


a rule for inferring a slot assignment based on evaluating a path through a sequence of slot assignments


key: pattern

description: the string value of the slot must conform to this regular expression expressed in the string


key: range

description:
defines the type of the object of the slot.  Given the following slot definition
  S1:
    domain: C1
    range:  C2
the declaration
  X:
    S1: Y

implicitly asserts Y is an instance of C2


A range that is described as a boolean expression combining existing ranges


key: rank

description: the relative order in which the element occurs, lower values are given precedence


key: readonly

description: If present, slot is read only.  Text explains why


key: recommended

description: true means that the slot should be present in instances of the class definition, but this is not required


key: reflexive

description: If s is reflexive, then i.s=i for all instances i


description: transitive_form_of including the reflexive case


description: A list of terms from different schemas or terminology systems that have related meaning.


the role a slot on a relationship class plays, for example, the subject, object or predicate roles


key: required

description: true means that the slot must be present in instances of the class definition


key: role

description: a textual descriptor that indicates the role played by the slot range


description: A list of related entities or URLs that may be of relevance


key: shared

description: If True, then the relationship between the slot domain and range is many to one or many to many


description: a name that is used in the singular form


description: allows for grouping of related slots into a grouping slot that serves the role of a group


description: URI of the class that provides a semantic interpretation of the slot in a linked data context. The URI may come from any namespace and may be shared between schemas.


key: source

description: A related resource from which the element is derived.


key: status

description: status of the element


description:
Used on a slot that stores the string serialization of the containing object. The syntax follows python formatted strings, with slot names enclosed in {}s. These are expanded using the values of those slots.
We call the slot with the serialization the s-slot, the slots used in the {}s are v-slots. If both s-slots and v-slots are populated on an object then the value of the s-slot should correspond to the expansion.
Implementations of frameworks may choose to use this property to either (a) PARSE: implement automated normalizations by parsing denormalized strings into complex objects (b) GENERARE: implement automated to_string labeling of complex objects
For example, a Measurement class may have 3 fields: unit, value, and string_value. The string_value slot may have a string_serialization of {value}{unit} such that if unit=cm and value=2, the value of string_value shouldd be 2cm


description: A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.


the string value of the slot must conform to the regular expression in the pattern expression


description: Ontology property which this slot is a subproperty of.  Note: setting this property on a slot does not guarantee an expansion of the ontological hierarchy into an enumerated list of possible values in every serialization of the model.


key: symmetric

description: If s is symmetric, and i.s=v, then v.s=i


key: title

description: A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.


key: todos

description: Outstanding issues that needs resolution


key: transitive

description: If s is transitive, and i.s=z, and s.s=j, then i.s=j


description: If s transitive_form_of d, then (1) s holds whenever d holds (2) s is transitive (3) d holds whenever s holds and there are no intermediates, and s is not reflexive


description: indicates that the domain element consists exactly of the members of the element in the range.


key: unit

description: an encoding of a unit


description: The name of the slot referenced in the slot_usage


if true then a value must be present (for lists there must be at least one value). If false then a value must be absent (for lists, must be empty)


description: The identifier of a "value set" -- a set of identifiers that form the possible values for the range of a slot. Note: this is different than 'subproperty_of' in that 'subproperty_of' is intended to be a single ontology term while 'values_from' is the identifier of an entire value set.  Additionally, this is different than an enumeration in that in an enumeration, the values of the enumeration are listed directly in the model itself. Setting this property on a slot does not guarantee an expansion of the ontological hierarchy into an enumerated list of possible values in every serialization of the model.


key: StructuredAlias

description: object that contains meta data about a synonym or alias including where it came from (source) and its scope (narrow, broad, etc.)


key: aliases

description: Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.


description: A sourced alternative description for an element


key: additionalProperties

description: text of an attributed description


key: annotations

description: a collection of tag/text tuples with the semantics of OWL Annotation


description: A list of terms from different schemas or terminology systems that have broader meaning.


key: categories

description: The category or categories of an alias. This can be drawn from any relevant vocabulary


description: A list of terms from different schemas or terminology systems that have close meaning.


key: comments

description: notes and comments about an element intended primarily for external consumption


key: contributors

description: agent that contributed to the element


description: agent that created the element


description: time at which the element was created


key: deprecated

description: Description of why and when this element will no longer be used


description: When an element is deprecated, it can be automatically replaced by this uri or curie


description: When an element is deprecated, it can be potentially replaced by this uri or curie


key: description

description: a textual description of the element's purpose and use


description: A list of terms from different schemas or terminology systems that have identical meaning.


key: examples

description: example usages of an element


key: extensions

description: a tag/text tuple attached to an arbitrary element


description: id of the schema that defined the element


description: the imports entry that this element was derived from.  Empty means primary source


description: the primary language used in the sources


description: used to indicate membership of a term in a defined subset of terms used for a particular domain or application.


key: keywords

description: Keywords or tags used to describe the element


description: time at which the element was last updated


description: The literal lexical form of a structured alias; i.e the actual alias value.


key: mappings

description: A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.


description: agent that modified the element


description: A list of terms from different schemas or terminology systems that have narrower meaning.


key: notes

description: editorial notes about an element intended primarily for internal consumption


key: predicate

description: The relationship between an element and its alias.


key: rank

description: the relative order in which the element occurs, lower values are given precedence


description: A list of terms from different schemas or terminology systems that have related meaning.


description: A list of related entities or URLs that may be of relevance


key: source

description: A related resource from which the element is derived.


key: status

description: status of the element


description: A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.


key: title

description: A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.


key: todos

description: Outstanding issues that needs resolution


key: SubsetDefinition

description: an element that can be used to group other metamodel elements


key: aliases

description: Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.


description: A sourced alternative description for an element


key: additionalProperties

description: text of an attributed description


key: annotations

description: a collection of tag/text tuples with the semantics of OWL Annotation


description: A list of terms from different schemas or terminology systems that have broader meaning.


key: categories

description: Controlled terms used to categorize an element.


description: A list of terms from different schemas or terminology systems that have close meaning.


key: comments

description: notes and comments about an element intended primarily for external consumption


description: An established standard to which the element conforms.


key: contributors

description: agent that contributed to the element


description: agent that created the element


description: time at which the element was created


description: The native URI of the element. This is always within the namespace of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri


key: deprecated

description: Description of why and when this element will no longer be used


description: When an element is deprecated, it can be automatically replaced by this uri or curie


description: When an element is deprecated, it can be potentially replaced by this uri or curie


key: description

description: a textual description of the element's purpose and use


description: A list of terms from different schemas or terminology systems that have identical meaning.


key: examples

description: example usages of an element


key: extensions

description: a tag/text tuple attached to an arbitrary element


description: id of the schema that defined the element


description: An allowed list of prefixes for which identifiers must conform. The identifier of this class or slot must begin with the URIs referenced by this prefix


key: implements

description: An element in another schema which this element conforms to. The referenced element is not imported into the schema for the implementing element. However, the referenced schema may be used to check conformance of the implementing element.


description: the imports entry that this element was derived from.  Empty means primary source


description: the primary language used in the sources


description: used to indicate membership of a term in a defined subset of terms used for a particular domain or application.


key: instantiates

description: An element in another schema which this element instantiates.


key: keywords

description: Keywords or tags used to describe the element


description: time at which the element was last updated


description: a name assigned to an element in a given ontology


key: mappings

description: A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.


description: agent that modified the element


key: name

description: the unique name of the element within the context of the schema.  Name is combined with the default prefix to form the globally unique subject of the target class.


description: A list of terms from different schemas or terminology systems that have narrower meaning.


key: notes

description: editorial notes about an element intended primarily for internal consumption


key: rank

description: the relative order in which the element occurs, lower values are given precedence


description: A list of terms from different schemas or terminology systems that have related meaning.


description: A list of related entities or URLs that may be of relevance


key: source

description: A related resource from which the element is derived.


key: status

description: status of the element


description: A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.


key: title

description: A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.


key: todos

description: Outstanding issues that needs resolution


description: an element that can be used to group other metamodel elements


key: aliases

description: Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.


description: A sourced alternative description for an element


key: additionalProperties

description: text of an attributed description


key: annotations

description: a collection of tag/text tuples with the semantics of OWL Annotation


description: A list of terms from different schemas or terminology systems that have broader meaning.


key: categories

description: Controlled terms used to categorize an element.


description: A list of terms from different schemas or terminology systems that have close meaning.


key: comments

description: notes and comments about an element intended primarily for external consumption


description: An established standard to which the element conforms.


key: contributors

description: agent that contributed to the element


description: agent that created the element


description: time at which the element was created


description: The native URI of the element. This is always within the namespace of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri


key: deprecated

description: Description of why and when this element will no longer be used


description: When an element is deprecated, it can be automatically replaced by this uri or curie


description: When an element is deprecated, it can be potentially replaced by this uri or curie


key: description

description: a textual description of the element's purpose and use


description: A list of terms from different schemas or terminology systems that have identical meaning.


key: examples

description: example usages of an element


key: extensions

description: a tag/text tuple attached to an arbitrary element


description: id of the schema that defined the element


description: An allowed list of prefixes for which identifiers must conform. The identifier of this class or slot must begin with the URIs referenced by this prefix


key: implements

description: An element in another schema which this element conforms to. The referenced element is not imported into the schema for the implementing element. However, the referenced schema may be used to check conformance of the implementing element.


description: the imports entry that this element was derived from.  Empty means primary source


description: the primary language used in the sources


description: used to indicate membership of a term in a defined subset of terms used for a particular domain or application.


key: instantiates

description: An element in another schema which this element instantiates.


key: keywords

description: Keywords or tags used to describe the element


description: time at which the element was last updated


description: a name assigned to an element in a given ontology


key: mappings

description: A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.


description: agent that modified the element


key: name

description: the unique name of the element within the context of the schema.  Name is combined with the default prefix to form the globally unique subject of the target class.


description: A list of terms from different schemas or terminology systems that have narrower meaning.


key: notes

description: editorial notes about an element intended primarily for internal consumption


key: rank

description: the relative order in which the element occurs, lower values are given precedence


description: A list of terms from different schemas or terminology systems that have related meaning.


description: A list of related entities or URLs that may be of relevance


key: source

description: A related resource from which the element is derived.


key: status

description: status of the element


description: A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.


key: title

description: A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.


key: todos

description: Outstanding issues that needs resolution


key: TypeDefinition

description: an element that whose instances are atomic scalar values that can be mapped to primitive types


key: aliases

description: Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.


description: holds if all of the expressions hold


description: A sourced alternative description for an element


key: additionalProperties

description: text of an attributed description


key: annotations

description: a collection of tag/text tuples with the semantics of OWL Annotation


description: holds if at least one of the expressions hold


key: base

description: python base type in the LinkML runtime that implements this type definition


description: A list of terms from different schemas or terminology systems that have broader meaning.


key: categories

description: Controlled terms used to categorize an element.


description: A list of terms from different schemas or terminology systems that have close meaning.


key: comments

description: notes and comments about an element intended primarily for external consumption


description: An established standard to which the element conforms.


key: contributors

description: agent that contributed to the element


description: agent that created the element


description: time at which the element was created


description: The native URI of the element. This is always within the namespace of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri


key: deprecated

description: Description of why and when this element will no longer be used


description: When an element is deprecated, it can be automatically replaced by this uri or curie


description: When an element is deprecated, it can be potentially replaced by this uri or curie


key: description

description: a textual description of the element's purpose and use


description: the slot must have range of a number and the value of the slot must equal the specified value


description: the slot must have range string and the value of the slot must equal the specified value


description: the slot must have range string and the value of the slot must equal one of the specified values


description: A list of terms from different schemas or terminology systems that have identical meaning.


description: holds if only one of the expressions hold


key: examples

description: example usages of an element


key: extensions

description: a tag/text tuple attached to an arbitrary element


description: id of the schema that defined the element


description: An allowed list of prefixes for which identifiers must conform. The identifier of this class or slot must begin with the URIs referenced by this prefix


key: implements

description: An element in another schema which this element conforms to. The referenced element is not imported into the schema for the implementing element. However, the referenced schema may be used to check conformance of the implementing element.


description: Causes the slot value to be interpreted as a uriorcurie after prefixing with this string


description: the imports entry that this element was derived from.  Empty means primary source


description: the primary language used in the sources


description: used to indicate membership of a term in a defined subset of terms used for a particular domain or application.


key: instantiates

description: An element in another schema which this element instantiates.


key: keywords

description: Keywords or tags used to describe the element


description: time at which the element was last updated


description: a name assigned to an element in a given ontology


key: mappings

description: A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.


description: for slots with ranges of type number, the value must be equal to or lowe than this


description: for slots with ranges of type number, the value must be equal to or higher than this


description: agent that modified the element


key: name

description: the unique name of the element within the context of the schema.  Name is combined with the default prefix to form the globally unique subject of the target class.


description: A list of terms from different schemas or terminology systems that have narrower meaning.


description: holds if none of the expressions hold


key: notes

description: editorial notes about an element intended primarily for internal consumption


key: pattern

description: the string value of the slot must conform to this regular expression expressed in the string


key: rank

description: the relative order in which the element occurs, lower values are given precedence


description: A list of terms from different schemas or terminology systems that have related meaning.


key: repr

description: the name of the python object that implements this type definition


description: A list of related entities or URLs that may be of relevance


key: source

description: A related resource from which the element is derived.


key: status

description: status of the element


description: A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.


the string value of the slot must conform to the regular expression in the pattern expression


key: title

description: A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.


key: todos

description: Outstanding issues that needs resolution


key: typeof

description: A parent type from which type properties are inherited


description: indicates that the domain element consists exactly of the members of the element in the range.


key: unit

description: an encoding of a unit


key: uri

description: The uri that defines the possible values for the type definition


description: an element that whose instances are atomic scalar values that can be mapped to primitive types


key: aliases

description: Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.


description: holds if all of the expressions hold


description: A sourced alternative description for an element


key: additionalProperties

description: text of an attributed description


key: annotations

description: a collection of tag/text tuples with the semantics of OWL Annotation


description: holds if at least one of the expressions hold


key: base

description: python base type in the LinkML runtime that implements this type definition


description: A list of terms from different schemas or terminology systems that have broader meaning.


key: categories

description: Controlled terms used to categorize an element.


description: A list of terms from different schemas or terminology systems that have close meaning.


key: comments

description: notes and comments about an element intended primarily for external consumption


description: An established standard to which the element conforms.


key: contributors

description: agent that contributed to the element


description: agent that created the element


description: time at which the element was created


description: The native URI of the element. This is always within the namespace of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri


key: deprecated

description: Description of why and when this element will no longer be used


description: When an element is deprecated, it can be automatically replaced by this uri or curie


description: When an element is deprecated, it can be potentially replaced by this uri or curie


key: description

description: a textual description of the element's purpose and use


description: the slot must have range of a number and the value of the slot must equal the specified value


description: the slot must have range string and the value of the slot must equal the specified value


description: the slot must have range string and the value of the slot must equal one of the specified values


description: A list of terms from different schemas or terminology systems that have identical meaning.


description: holds if only one of the expressions hold


key: examples

description: example usages of an element


key: extensions

description: a tag/text tuple attached to an arbitrary element


description: id of the schema that defined the element


description: An allowed list of prefixes for which identifiers must conform. The identifier of this class or slot must begin with the URIs referenced by this prefix


key: implements

description: An element in another schema which this element conforms to. The referenced element is not imported into the schema for the implementing element. However, the referenced schema may be used to check conformance of the implementing element.


description: Causes the slot value to be interpreted as a uriorcurie after prefixing with this string


description: the imports entry that this element was derived from.  Empty means primary source


description: the primary language used in the sources


description: used to indicate membership of a term in a defined subset of terms used for a particular domain or application.


key: instantiates

description: An element in another schema which this element instantiates.


key: keywords

description: Keywords or tags used to describe the element


description: time at which the element was last updated


description: a name assigned to an element in a given ontology


key: mappings

description: A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.


description: for slots with ranges of type number, the value must be equal to or lowe than this


description: for slots with ranges of type number, the value must be equal to or higher than this


description: agent that modified the element


key: name

description: the unique name of the element within the context of the schema.  Name is combined with the default prefix to form the globally unique subject of the target class.


description: A list of terms from different schemas or terminology systems that have narrower meaning.


description: holds if none of the expressions hold


key: notes

description: editorial notes about an element intended primarily for internal consumption


key: pattern

description: the string value of the slot must conform to this regular expression expressed in the string


key: rank

description: the relative order in which the element occurs, lower values are given precedence


description: A list of terms from different schemas or terminology systems that have related meaning.


key: repr

description: the name of the python object that implements this type definition


description: A list of related entities or URLs that may be of relevance


key: source

description: A related resource from which the element is derived.


key: status

description: status of the element


description: A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.


the string value of the slot must conform to the regular expression in the pattern expression


key: title

description: A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.


key: todos

description: Outstanding issues that needs resolution


key: typeof

description: A parent type from which type properties are inherited


description: indicates that the domain element consists exactly of the members of the element in the range.


key: unit

description: an encoding of a unit


key: uri

description: The uri that defines the possible values for the type definition


key: UniqueKey

description: a collection of slots whose values uniquely identify an instance of a class


key: aliases

description: Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.


description: A sourced alternative description for an element


key: additionalProperties

description: text of an attributed description


key: annotations

description: a collection of tag/text tuples with the semantics of OWL Annotation


description: A list of terms from different schemas or terminology systems that have broader meaning.


key: categories

description: Controlled terms used to categorize an element.


description: A list of terms from different schemas or terminology systems that have close meaning.


key: comments

description: notes and comments about an element intended primarily for external consumption


description: By default, None values are considered equal for the purposes of comparisons in determining uniqueness. Set this to true to treat missing values as per ANSI-SQL NULLs, i.e NULL=NULL is always False.


key: contributors

description: agent that contributed to the element


description: agent that created the element


description: time at which the element was created


key: deprecated

description: Description of why and when this element will no longer be used


description: When an element is deprecated, it can be automatically replaced by this uri or curie


description: When an element is deprecated, it can be potentially replaced by this uri or curie


key: description

description: a textual description of the element's purpose and use


description: A list of terms from different schemas or terminology systems that have identical meaning.


key: examples

description: example usages of an element


key: extensions

description: a tag/text tuple attached to an arbitrary element


description: id of the schema that defined the element


description: the imports entry that this element was derived from.  Empty means primary source


description: the primary language used in the sources


description: used to indicate membership of a term in a defined subset of terms used for a particular domain or application.


key: keywords

description: Keywords or tags used to describe the element


description: time at which the element was last updated


key: mappings

description: A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.


description: agent that modified the element


description: A list of terms from different schemas or terminology systems that have narrower meaning.


key: notes

description: editorial notes about an element intended primarily for internal consumption


key: rank

description: the relative order in which the element occurs, lower values are given precedence


description: A list of terms from different schemas or terminology systems that have related meaning.


description: A list of related entities or URLs that may be of relevance


key: source

description: A related resource from which the element is derived.


key: status

description: status of the element


description: A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.


key: title

description: A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.


key: todos

description: Outstanding issues that needs resolution


description: name of the unique key


description: list of slot names that form a key. The tuple formed from the values of all these slots should be unique.


description: a collection of slots whose values uniquely identify an instance of a class


key: aliases

description: Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.


description: A sourced alternative description for an element


key: additionalProperties

description: text of an attributed description


key: annotations

description: a collection of tag/text tuples with the semantics of OWL Annotation


description: A list of terms from different schemas or terminology systems that have broader meaning.


key: categories

description: Controlled terms used to categorize an element.


description: A list of terms from different schemas or terminology systems that have close meaning.


key: comments

description: notes and comments about an element intended primarily for external consumption


description: By default, None values are considered equal for the purposes of comparisons in determining uniqueness. Set this to true to treat missing values as per ANSI-SQL NULLs, i.e NULL=NULL is always False.


key: contributors

description: agent that contributed to the element


description: agent that created the element


description: time at which the element was created


key: deprecated

description: Description of why and when this element will no longer be used


description: When an element is deprecated, it can be automatically replaced by this uri or curie


description: When an element is deprecated, it can be potentially replaced by this uri or curie


key: description

description: a textual description of the element's purpose and use


description: A list of terms from different schemas or terminology systems that have identical meaning.


key: examples

description: example usages of an element


key: extensions

description: a tag/text tuple attached to an arbitrary element


description: id of the schema that defined the element


description: the imports entry that this element was derived from.  Empty means primary source


description: the primary language used in the sources


description: used to indicate membership of a term in a defined subset of terms used for a particular domain or application.


key: keywords

description: Keywords or tags used to describe the element


description: time at which the element was last updated


key: mappings

description: A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.


description: agent that modified the element


description: A list of terms from different schemas or terminology systems that have narrower meaning.


key: notes

description: editorial notes about an element intended primarily for internal consumption


key: rank

description: the relative order in which the element occurs, lower values are given precedence


description: A list of terms from different schemas or terminology systems that have related meaning.


description: A list of related entities or URLs that may be of relevance


key: source

description: A related resource from which the element is derived.


key: status

description: status of the element


description: A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.


key: title

description: A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.


key: todos

description: Outstanding issues that needs resolution


description: name of the unique key


description: list of slot names that form a key. The tuple formed from the values of all these slots should be unique.


key: UnitOfMeasure

description: A unit of measure, or unit, is a particular quantity value that has been chosen as a scale for measuring other quantities the same kind (more generally of equivalent dimension).


key: abbreviation

description: An abbreviation for a unit is a short ASCII string that is used in place of the full name for the unit in contexts where non-ASCII characters would be problematic, or where using the abbreviation will enhance readability. When a power of a base unit needs to be expressed, such as squares this can be done using abbreviations rather than symbols (source: qudt)


key: derivation

description: Expression for deriving this unit from other units


description: the spelled out name of the unit, for example, meter


description: Used to link a unit to equivalent concepts in ontologies such as UO, SNOMED, OEM, OBOE, NCIT


description: Concept in a vocabulary or ontology that denotes the kind of quanity being measured, e.g. length


key: symbol

description: name of the unit encoded as a symbol


description: associates a QUDT unit with its UCUM code (case-sensitive).


key: aliases

description: Alternate names/labels for the element. These do not alter the semantics of the schema, but may be useful to support search and alignment.


description: A sourced alternative description for an element


key: additionalProperties

description: text of an attributed description


key: annotations

description: a collection of tag/text tuples with the semantics of OWL Annotation


description: A list of terms from different schemas or terminology systems that have broader meaning.


key: categories

description: Controlled terms used to categorize an element.


key: classes

description: An index to the collection of all class definitions in the schema


description: A list of terms from different schemas or terminology systems that have close meaning.


key: comments

description: notes and comments about an element intended primarily for external consumption


description: An established standard to which the element conforms.


key: contributors

description: agent that contributed to the element


description: agent that created the element


description: time at which the element was created


description: ordered list of prefixcommon biocontexts to be fetched to resolve id prefixes and inline prefix variables


description: The prefix that is used for all elements within a schema


description: default slot range to be used if range element is omitted from a slot definition


description: The native URI of the element. This is always within the namespace of the containing schema. Contrast with the assigned URI, via class_uri or slot_uri


key: deprecated

description: Description of why and when this element will no longer be used


description: When an element is deprecated, it can be automatically replaced by this uri or curie


description: When an element is deprecated, it can be potentially replaced by this uri or curie


key: description

description: a textual description of the element's purpose and use


description: a list of Curie prefixes that are used in the representation of instances of the model.  All prefixes in this list are added to the prefix sections of the target models.


key: enums

description: An index to the collection of all enum definitions in the schema


description: A list of terms from different schemas or terminology systems that have identical meaning.


key: examples

description: example usages of an element


key: extensions

description: a tag/text tuple attached to an arbitrary element


description: id of the schema that defined the element


description: date and time that the schema was loaded/generated


key: id

description: The official schema URI


description: An allowed list of prefixes for which identifiers must conform. The identifier of this class or slot must begin with the URIs referenced by this prefix


key: implements

description: An element in another schema which this element conforms to. The referenced element is not imported into the schema for the implementing element. However, the referenced schema may be used to check conformance of the implementing element.


description: the imports entry that this element was derived from.  Empty means primary source


key: imports

description: A list of schemas that are to be included in this schema


description: the primary language used in the sources


description: used to indicate membership of a term in a defined subset of terms used for a particular domain or application.


key: instantiates

description: An element in another schema which this element instantiates.


key: keywords

description: Keywords or tags used to describe the element


description: time at which the element was last updated


key: license

description: license for the schema


key: additionalProperties

description: a name assigned to an element in a given ontology


key: mappings

description: A list of terms from different schemas or terminology systems that have comparable meaning. These may include terms that are precisely equivalent, broader or narrower in meaning, or otherwise semantically related but not equivalent from a strict ontological perspective.


description: Version of the metamodel used to load the schema


description: agent that modified the element


key: name

description: a unique name for the schema that is both human-readable and consists of only characters from the NCName set


description: A list of terms from different schemas or terminology systems that have narrower meaning.


key: notes

description: editorial notes about an element intended primarily for internal consumption


key: prefixes

description: A collection of prefix expansions that specify how CURIEs can be expanded to URIs


description: The namespace to which a prefix expands to.


key: rank

description: the relative order in which the element occurs, lower values are given precedence


description: A list of terms from different schemas or terminology systems that have related meaning.


description: A list of related entities or URLs that may be of relevance


key: settings

description: A collection of global variable settings


description: The value assigned for a setting


description: if true then induced/mangled slot names are not created for class_usage and attributes


key: slots

description: An index to the collection of all slot definitions in the schema


key: source

description: A related resource from which the element is derived.


description: name, uri or description of the source of the schema


description: modification date of the source of the schema


description: size in bytes of the source of the schema


key: status

description: status of the element


description: A list of structured_alias objects, used to provide aliases in conjunction with additional metadata.


key: subsets

description: An index to the collection of all subset definitions in the schema


key: title

description: A concise human-readable display label for the element. The title should mirror the name, and should use ordinary textual punctuation.


key: todos

description: Outstanding issues that needs resolution


key: types

description: An index to the collection of all type definitions in the schema


key: version

description: particular version of schema


description: Defines *user* configuration for the SSH agent, and allows the user to configure which accounts, vaults, and items should be considered for use by the SSH agent.


key: ssh-keys

description: The list of rules to decide which accounts, vaults, and items to add to the SSH agent.


key: AgentConfigRule

description: A single rule defined in the SSH agent config for which keys to include in the SSH agent. Each field may be the UUID or another identifier, which varies per field.


key: account

description: Can be either an account UUID or signin address or account name


key: item

description: Can be either an item UUID or name


key: vault

description: Can be either a vault UUID or name


key: expand

description: Must be set to true to use properties other than 'src' and 'dest'


key: cwd

description: All 'src' matches are relative to (but don't include) this path


key: dest

description: Destination path prefix.


key: ext

description: Replace any existing extension with this value in generated 'dest' paths.


key: extDot

description: Used to indicate where the period indicating the extension is located.

enum: first last

default: first


key: filter

description: The 'filter' property can help you target files with a greater level of detail

enum: isFile isDirectory isBlockDevice isCharacterDevice isSymbolicLink isFIFO isSocket


key: flatten

description: Remove all path parts from generated 'dest' paths


key: matchBase

description: If set, patterns without slashes will be matched against the basename of the path if it contains slashes. For example, 'a?b' would match the path '/xyz/123/acb', but not '/xyz/acb/123'.


key: nonull

description: If set to 'true' then the operation will include non-matching patterns. Combined with grunt's '--verbose' flag, this option can help debug file path issues.


key: rename

description: This function is called for each matched 'src' file, (after extension renaming and flattening).


key: src

description: Pattern(s) to match, relative to the 'cwd'.


key: executablePath

description: An absolute path to the to the executable.


key: commandName

description: The name of the command to call.


key: name

description: The name of the debug profile


key: commandLineArgs

description: The arguments to pass to the command.


key: workingDirectory

description: Sets the working directory of the command.


key: launchBrowser

description: Set to true if the browser should be launched.


key: launchUrl

description: The relative URL to launch in the browser.

format: uri


key: environmentVariables

description: Set the environment variables as key/value pairs.


key: sdkVersion

description: Sets the version of the SDK.


key: profiles

description: A list of debug profiles


description: This is a JSON schema representation of the schema.org Thing schema: https://schema.org/Thing

format: regex


description: override the @context property to ensure the schema.org URI is used


key: additionalType

description: An additional type for the item, typically used for adding more specific types from external vocabularies in microdata syntax. This is a relationship between something and a class that the thing is in. In RDFa syntax, it is better to use the native RDFa syntax - the 'typeof' attribute - for multiple types. Schema.org tools may have only weaker understanding of extra types, in particular those defined externally.


key: alternateName

description: An alias for the item.


key: description

description: A description of the item.


key: disambiguatingDescription

description: A sub property of description. A short description of the item used to disambiguate from other, similar items. Information from other properties (in particular, name) may be necessary for the description to be useful for disambiguation.


key: image

description: An image of the item. This can be a URL or a fully described ImageObject.


key: mainEntityOfPage

description: Indicates a page (or other CreativeWork) for which this thing is the main entity being described. See background notes for details. Inverse property mainEntity.


description: The name of the item.


key: potentialAction

description: Indicates a potential Action, which describes an idealized action in which this thing would play an 'object' role.


key: sameAs

description: URL of a reference Web page that unambiguously indicates the item's identity. E.g. the URL of the item's Wikipedia page, Freebase page, or official website.


key: url

description: URL of the item.


description: 解析后的 YML 数据

enum: action chance emotion painPoint stage thought

type: number

required: actions name


key: Config

description: 图表配置


key: color

description: 旅程图主色风格


key: height

description: 每个部分的高度


key: sections

description:
待显示的区块
默认为: ['stage', 'action', 'emotion','thought']


key: title

description: 显示旅程图标题


key: UserAction

description: 用户行为类型


description: 展示颜色


description: 说明


key: emotion

description: 情绪得分


key: name

description: 行为名称


key: painPoints

description: 痛点


key: thoughts

description: 想法


key: YMLStage

description: YML 的阶段类型


key: actions

description: 该阶段所有用户行为


description: 阶段名称


key: config

description: 配置参数


key: stages

description: 步骤


description: 标题名


description:
The configuration file used by the All Contributors CLI and GitHub bot.
https://allcontributors.org/docs/en/bot/configuration

enum: github gitlab

default: github

enum: angular atom ember eslint jshint gitmoji none

default: angular

required: projectName projectOwner


key: repoHost

description:
Change it if you use a self-hosted repository.
Default: https://github.com if repoType is github, and https://gitlab.com if repoType is gitlab


key: person

description: A person who has been involved in creating or maintaining this package.

type: object string

format: email


key: dependency

description: Dependencies are specified with a simple hash of package name to version range. The version range is a string which has one or more space-separated descriptors. Dependencies can also be identified with a tarball or git URL.


key: scriptsInstallAfter

description: Run AFTER the package is installed.

x-intellij-language-injection: Shell Script


key: scriptsPublishAfter

description: Run AFTER the package is published.


key: scriptsRestart

description: Run by the 'npm restart' command. Note: 'npm restart' will run the stop and start scripts if no restart script is provided.


key: scriptsStart

description: Run by the 'npm start' command.


key: scriptsStop

description: Run by the 'npm stop' command.


key: scriptsTest

description: Run by the 'npm test' command.


key: scriptsUninstallBefore

description: Run BEFORE the package is uninstalled.


key: scriptsVersionBefore

description: Run BEFORE bump the package version.


key: packageExportsEntryPath

description: The module path that is resolved when this specifier is imported. Set to `null` to disallow importing this module.


key: packageExportsEntryObject

description: Used to specify conditional exports, note that Conditional exports are unsupported in older environments, so it's recommended to use the fallback array option if support for those environments is a concern.


key: require

description: The module path that is resolved when this specifier is imported as a CommonJS module using the `require(...)` function.


key: import

description: The module path that is resolved when this specifier is imported as an ECMAScript module using an `import` declaration or the dynamic `import(...)` function.


key: node

description: The module path that is resolved when this environment is Node.js.


key: default

description: The module path that is resolved when no other export type matches.


key: types

description: The module path that is resolved for TypeScript types when this specifier is imported. Should be listed before other conditions.


The module path that is resolved when this environment matches the property name.


key: packageExportsFallback

description: Used to allow fallbacks in case this environment doesn't support the preceding entries.


key: fundingUrl

description: URL to a website with details about how to fund the package.


key: fundingWay

description: Used to inform about ways to help fund development of the package.


key: type

description: The type of funding or the platform through which funding can be provided, e.g. patreon, opencollective, tidelift or github.


description: Any property starting with _ is valid.

tsType: any


key: name

description: The name of the package.


key: version

description: Version must be parseable by node-semver, which is bundled with npm as a dependency.


key: description

description: This helps people discover your package, as it's listed in 'npm search'.


key: keywords

description: This helps people discover your package as it's listed in 'npm search'.


key: homepage

description: The url to the project homepage.


key: bugs

description: The url to your project's issue tracker and / or the email address to which issues should be reported. These are helpful for people who encounter issues with your package.


key: url

description: The url to your project's issue tracker.


key: email

description: The email address to which issues should be reported.


key: license

description: You should specify a license for your package so that people know how they are permitted to use it, and any restrictions you're placing on it.


key: licenses

description: DEPRECATED: Instead, use SPDX expressions, like this: { "license": "ISC" } or { "license": "(MIT OR Apache-2.0)" } see: 'https://docs.npmjs.com/files/package.json#license'.


key: contributors

description: A list of people who contributed to this package.


key: maintainers

description: A list of people who maintains this package.


key: files

description: The 'files' field is an array of files to include in your project. If you name a folder in the array, then it will also include the files inside that folder.


key: main

description: The main field is a module ID that is the primary entry point to your program.


key: exports

description: The "exports" field is used to restrict external access to non-exported module files, also enables a module to import itself using "name".


description: The module path that is resolved when the module specifier matches "name", shadows the "main" field.


The module path prefix that is resolved when the module specifier starts with "name/", set to "./*" to allow external modules to import any subpath.


description: When set to "module", the type field allows a package to specify all .js files within are ES modules. If the "type" field is omitted or set to "commonjs", all .js files are treated as CommonJS.

enum: commonjs module

default: commonjs


key: types

description: Set the types property to point to your bundled declaration file.


key: typings

description: Note that the "typings" field is synonymous with "types", and could be used as well.


key: typesVersions

description: The "typesVersions" field is used since TypeScript 3.1 to support features that were only made available in newer TypeScript versions.


key: additionalProperties

description: Contains overrides for the TypeScript version that matches the version range matching the property key.


description: Maps all file paths to the file paths specified in the array.


description: Maps the file path matching the property key to the file paths specified in the array.


description: Maps file paths matching the pattern specified in property key to file paths specified in the array.


key: man

description: Specify either a single file or an array of filenames to put in place for the man program to find.

type: array string


key: bin

description: If you specify a 'bin' directory, then all the files in that folder will be used as the 'bin' hash.


key: doc

description: Put markdown files in here. Eventually, these will be displayed nicely, maybe, someday.


key: example

description: Put example scripts in here. Someday, it might be exposed in some clever way.


key: lib

description: Tell people where the bulk of your library is. Nothing special is done with the lib folder in any way, but it's useful meta info.


description: A folder that is full of man pages. Sugar to generate a 'man' array by walking the folder.


key: repository

description: Specify the place where your code lives. This is helpful for people who want to contribute.


key: scripts

description: The 'scripts' member is an object hash of script commands that are run at various times in the lifecycle of your package. The key is the lifecycle event, and the value is the command to run at that point.

tsType: string | undefined


key: lint

description: Run code quality tools, e.g. ESLint, TSLint, etc.


key: prepublish

description: Run BEFORE the package is published (Also run on local npm install without any arguments).


key: prepare

description: Run both BEFORE the package is packed and published, and on local npm install without any arguments. This is run AFTER prepublish, but BEFORE prepublishOnly.


key: prepublishOnly

description: Run BEFORE the package is prepared and packed, ONLY on npm publish.


key: prepack

description: run BEFORE a tarball is packed (on npm pack, npm publish, and when installing git dependencies).


key: postpack

description: Run AFTER the tarball has been generated and moved to its final destination.


key: publish

description: Publishes a package to the registry so that it can be installed by name. See https://docs.npmjs.com/cli/v8/commands/npm-publish


key: preinstall

description: Run BEFORE the package is installed.


key: postuninstall

description: Run AFTER the package is uninstalled.


key: postversion

description: Run AFTER bump the package version.


key: serve

description: Start dev server to serve application files


key: config

description: A 'config' hash can be used to set configuration parameters used in package scripts that persist across upgrades.


key: peerDependenciesMeta

description: When a user installs your package, warnings are emitted if packages specified in "peerDependencies" are not already installed. The "peerDependenciesMeta" field serves to provide more information on how your peer dependencies are utilized. Most commonly, it allows peer dependencies to be marked as optional. Metadata for this field is specified with a simple hash of the package name to a metadata object.


key: optional

description: Specifies that this peer dependency is optional and should not be installed automatically.


key: bundledDependencies

description: Array of package names that will be bundled when publishing the package.


key: bundleDependencies

description: DEPRECATED: This field is honored, but "bundledDependencies" is the correct field name.


key: resolutions

description: Resolutions is used to support selective version resolutions using yarn, which lets you define custom package versions or ranges inside your dependencies. For npm, use overrides instead. See: https://classic.yarnpkg.com/en/docs/selective-version-resolutions


key: overrides

description: Overrides is used to support selective version overrides using npm, which lets you define custom package versions or ranges inside your dependencies. For yarn, use resolutions instead. See: https://docs.npmjs.com/cli/v9/configuring-npm/package-json#overrides


key: packageManager

description: Defines which package manager is expected to be used when working on the current project. This field is currently experimental and needs to be opted-in; see https://nodejs.org/api/corepack.html


key: os

description: Specify which operating systems your module will run on.


key: cpu

description: Specify that your code only runs on certain cpu architectures.


key: preferGlobal

description: DEPRECATED: This option used to trigger an npm warning, but it will no longer warn. It is purely there for informational purposes. It is now recommended that you install any binaries as local devDependencies wherever possible.


key: private

description: If set to true, then npm will refuse to publish it.

enum: false true


key: module

description: An ECMAScript module ID that is the primary entry point to your program.


key: esnext

description: A module ID with untranspiled code that is the primary entry point to your program.

type: string object


key: workspaces

description: Allows packages within a directory to depend on one another using direct linking of local files. Additionally, dependencies within a workspace are hoisted to the workspace root when possible to reduce duplication. Note: It's also a good idea to set "private" to true when using this feature.


description: Workspace package paths. Glob patterns are supported.


key: packages


key: nohoist

description: Packages to block from hoisting to the workspace root. Currently only supported in Yarn only.


description:
A pack metadata
https://minecraft.fandom.com/wiki/Data_pack


key: pack

description:
Options for the current pack
https://minecraft.fandom.com/wiki/Data_pack#Contents


key: description

description:
A description for the current pack
https://minecraft.fandom.com/wiki/Data_pack#Contents


description:
A version for the current pack
https://minecraft.fandom.com/wiki/Data_pack#Contents


key: filter

description:
Filter options for the current pack
https://minecraft.fandom.com/wiki/Data_pack


key: additionalProperties

description:
A pattern for the current pack
https://minecraft.fandom.com/wiki/Data_pack


key: namespace

description:
A namespace regular expression for the current pack
https://minecraft.fandom.com/wiki/Data_pack


key: path

description:
A path regular expression for the current pack
https://minecraft.fandom.com/wiki/Data_pack


key: concurrency

description: The number of connections to make simultaneously.


key: config

description: The config file path.


key: recurse

description: By default, all scans are shallow. Only the top level links on the requested page will be scanned. By setting recurse to true, the crawler will follow all links on the page, and continue scanning links on the same domain for as long as it can go. Results are cached, so no worries about loops.


key: skip

description: List of urls in regexy form to not include in the check.


key: format

description: Return the data in CSV or JSON format.

default: json

enum: json text csv


key: silent

description: If true, does not show links


key: verbosity

description: The output verbosity

default: error


key: timeout

description: By default, requests made by linkinator do not time out (or follow the settings of the OS). This option (in milliseconds) will fail requests after the configured amount of time.


key: markdown

description: Automatically parse and scan markdown if scanning from a location on disk.


key: serverRoot

description: When scanning a locally directory, customize the location on disk where the server is started. Defaults to the path passed in path.


key: directoryListing

description: Automatically serve a static file listing page when serving a directory. Defaults to false.


key: retry

description: Automatically retry requests that respond with an HTTP 429, and include a retry-after header. The RetryConfig option is a placeholder for fine-grained controls to be implemented at a later time, and is only included here to signal forward-compatibility.


key: retryErrors

description: Automatically retry requests that return 5xx or unknown response.


key: retryErrorsCount

description: How many times should an error be retried?


key: retryErrorsJitter

description: Random jitter applied to error retry.


key: urlRewriteExpressions

description: Collection of objects that contain a search pattern, and replacement.


Super-schema that describes all versions of 'CICS region tagging file JSON Schema.'


Schema that describes the contents of a CICS region tagging file.


key: translationEntry

description: Translation key


key: message

description: Translation string


key: description

description: (optional): Description of this string for the translator team


key: placeholders

description: (optional): List of placeholders that can be used in the message.


key: placeholder

description: Placeholder key


key: content

description: Value to insert. It can contain a variable $1


key: example

description: (optional) example of this placeholder


description: Syntactic units in unist syntax trees are called nodes, and implement the Node interface.

required: column line

required: end start


key: Point

description: A point represents one place in a source file. The value of the point field implements the Point interface.


key: column

description: The column field (1-indexed integer) represents a column in a source file.


key: line

description: The line field (1-indexed integer) represents a line in a source file.


key: offset

description: The offset field (0-indexed integer) represents a character in a source file.


key: Position

description: A position represents the location of a node in a source file. The value of the position field implements the Position interface. The position field must not be present if a node is generated.


key: end

description: The end field of Position represents the place of the first character after the parsed source region, whether it exists or not.


key: start

description: The start field of Position represents the place of the first character of the parsed source region.


key: type

description: The type field is a non-empty string representing the variant of a node. This field can be used to determine the type a node implements.


key: children

description: The children field is a list representing the children of a node.


key: data

description: The data field represents information from the ecosystem. The value of the data field implements the Data interface.


key: value

description: The value field can contain any value.


key: scopeName

description: this should be a unique name for the grammar, following the convention of being a dot-separated name where each new (left-most) part specializes the name. Normally it would be a two-part name where the first is either text or source and the second is the name of the language or document type. But if you are specializing an existing type, you probably want to derive the name from the type you are specializing. For example Markdown is text.html.markdown and Ruby on Rails (rhtml files) is text.html.rails. The advantage of deriving it from (in this case) text.html is that everything which works in the text.html scope will also work in the text.html.«something» scope (but with a lower precedence than something specifically targeting text.html.«something»).


key: foldingStartMarker

description: regular expressions that lines (in the document) are matched against. If a line matches one of the patterns (but not both), it becomes a folding marker (see the foldings section for more info).


key: foldingStopMarker


key: fileTypes

description: this is an array of file type extensions that the grammar should (by default) be used with. This is referenced when TextMate does not know what grammar to use for a file the user opens. If however the user selects a grammar from the language pop-up in the status bar, TextMate will remember that choice.


key: repository

description: a dictionary (i.e. key/value pairs) of rules which can be included from other places in the grammar. The key is the name of the rule and the value is the actual rule. Further explanation (and example) follow with the description of the include rule key.


key: disabled

description: set this property to 1 to disable the current pattern


key: include

description: this allows you to reference a different language, recursively reference the grammar itself or a rule declared in this file's repository.


key: match

description: a regular expression which is used to identify the portion of text to which the name should be assigned. Example: '\b(true|false)\b'.


key: name

description: the name which gets assigned to the portion matched. This is used for styling and scope-specific settings and actions, which means it should generally be derived from one of the standard names.


key: contentName

description: this key is similar to the name key but only assigns the name to the text between what is matched by the begin/end patterns.


key: begin

description: these keys allow matches which span several lines and must both be mutually exclusive with the match key. Each is a regular expression pattern. begin is the pattern that starts the block and end is the pattern which ends the block. Captures from the begin pattern can be referenced in the end pattern by using normal regular expression back-references. This is often used with here-docs. A begin/end rule can have nested patterns using the patterns key.


key: end


key: while

description: these keys allow matches which span several lines and must both be mutually exclusive with the match key. Each is a regular expression pattern. begin is the pattern that starts the block and while continues it.


key: captures

description: allows you to assign attributes to the captures of the match pattern. Using the captures key for a begin/end rule is short-hand for giving both beginCaptures and endCaptures with same values.


key: beginCaptures

description: allows you to assign attributes to the captures of the begin pattern. Using the captures key for a begin/end rule is short-hand for giving both beginCaptures and endCaptures with same values.


key: endCaptures

description: allows you to assign attributes to the captures of the end pattern. Using the captures key for a begin/end rule is short-hand for giving both beginCaptures and endCaptures with same values.


key: whileCaptures

description: allows you to assign attributes to the captures of the while pattern. Using the captures key for a begin/while rule is short-hand for giving both beginCaptures and whileCaptures with same values.


key: patterns

description: applies to the region between the begin and end matches


key: app

description: Application namespace

type: string array


key: aws

description: AWS specific configuration

type: array object

enum: apigateway bucket concurrency layer layers memory policy policies profile region runtime timeout

type: string number

type: string object array


key: static

description: Static asset & S3 configuration

enum: fingerprint folder ignore prefix production prune spa staging

type: string boolean array object

type: boolean string


key: ws

description: API Gateway WebSocket configuration


key: http

description: API Gateway configuration

enum: any get post put patch delete head options


key: proxy

description: Proxy

enum: testing staging production


key: events

description: Events configuration


key: queues

description: Queues configuration


key: macros

description: Deployment macros configuration


key: scheduled

description: Scheduled event configuration

pattern: ^(rate|cron)


key: tables

description: DynamoDB database tables configuration


key: indexes

description: DynamoDB global secondary indexes configuration


description: Pyright Configuration Schema

enum: none information warning error

type: string boolean

enum: off basic strict

default: basic

default: warning

pattern: ^(Linux|Windows|Darwin|All)$


key: lintersMap

description: keys (String) are glob patterns, values (Array<String> | String) are commands to execute.


key: globOptions

description: micromatch options to customize how glob patterns match files.


key: concurrent

description: Controls if linters are run simultaneously for each glob pattern.


key: chunkSize

description: Max allowed chunk size based on number of files for glob pattern. This option is only applicable on Windows based systems to avoid command length limitations


key: linters


key: ignore

description: array of glob patterns to entirely ignore from any task.


key: subTaskConcurrency

description: Controls concurrency for processing chunks generated for each linter. This option is only applicable on Windows. Execution is not concurrent by default.


key: relative

description: If true it will give the relative path from your package.json directory to your linter arguments.


key: FormattingOptions

description: Used to control C# formatting

default: single

default: oneLess


key: RoslynExtensionsOptions

description: Used to define refactorings, code actions and analyzer locations that OmniSharp should use (i.e. Roslynator)


key: EnableAnalyzersSupport

description: If set to false, only refactorings are available


key: FileOptions

description: Used to define which directories and files should be included in OmniSharp's project file / solution file discovery process. Not individual .cs files.


key: SystemExcludeSearchPatterns

description: Recommended for manual editing


key: ExcludeSearchPatterns

description: Can be used by tools such as VS Code to automatically share its exclusion settings with OmniSharp


key: msbuild

description: Used to configure MSBuild solutions and projects

enum: Debug Release

default: AnyCPU


key: ToolsVersion

description: Value of ToolsVersion to use when building projects passed to this task


key: Configuration

description: Build configuration used for project evaluation


key: Platform

description: Specifies which version of the Common Language Runtime (CLR) use for project evaluation


key: MSBuildExtensionsPath

description: MSBuild extensions path. On Standalone this defaults to the MSBuild folder. In VisualStudio mode this folder will be %VSINSTALLDIR%\MSBuild


key: TargetFrameworkRootPath

description: Root directory where the target framework will be looked for. Uses default path if this is null


key: MSBuildSDKsPath

description: Path to the Sdks folder for this MSBuild instance


key: CscToolPath

description: Local Roslyn path (e.g. <MSBuildPath>/Current/Bin/Roslyn)


key: CscToolExe

description: FileName of C# compiler


key: loadProjectsOnDemand

description: If true, MSBuild project system will only be loading projects for files that were opened in the editor as well as referenced projects, recursively


key: script

description: Used to configure C# scripting (CSX files)


key: rspFilePath

description: A response file (.rsp) is used to provide the command line arguments that are used to run the roslyn script compiler process. You can use this to override the default namespace includes among other things.


key: cake

description: Used to configure Cake (cake files)


key: rootDir

description: The root directory that all others paths in this config are relative to. Usually the root of your repo. If omitted, rootDir is equal to the directory containing your Cosmos config. When you don't use a Cosmos config, rootDir defaults to the current working directory.


key: exportPath

description: Where to generate static exports on disk. [default: "cosmos-export"]


key: detectLocalPlugins

description: Automatically detect and load local plugins


key: disablePlugins

description: Disable plugins


key: staticPath

description: Dir path to serve static assets from.


key: plugins

description: Module IDs of Cosmos plugins (eg. "react-cosmos-plugin-open-fixture" or "../path/to/my-plugin").


key: publicUrl

description: Base URL for static assets. [default: "/"]


key: fixturesDir

description: Name for directories that contain fixtures (eg. __fixtures__/example.jsx). [default: "__fixtures__"]


key: fixtureFileSuffix

description: Suffix for fixture files (eg. example.fixture.jsx). [default: "fixture"]


key: ignore

description: Patterns for ignoring fixture and decorator files (eg. ["**/dist/**"]]).


key: watchDirs

description: Directories where the Cosmos server watches for fixture files changes while running. [default: ["."]]


key: lazy

description: Dynamically import fixture and decorator modules as they are loaded. When false all fixture and decorator modules are imported statically and bundled together. [default: false]


key: exposeImports

description: Expose user imports and config required for the Cosmos renderer. Used with React Native and in custom integrations. When a path is specified it requires a file extension (eg. "src/cosmos.imports.ts"). [default: false]


key: hostname

description: Dev server hostname. Set to null to accept connections with any hostname. [default: null]


key: port

description: Dev server port. [default: 5000]


key: portRetries

description: Max number of port retries. [default: 10]


key: https

description: Server will be served over HTTPS.


key: httpsOptions

description: Additional options for HTTPS server.


key: certPath

description: Path of a certificate file


key: keyPath

description: Path of a certificate's key file


key: httpProxy

description: Proxy some URLs to a different HTTP server (eg. an API backend dev server). Similar to devServer.proxy in webpack config.

enum: error debug info warn silent


description: Advanced HTTP proxy config.


key: globalImports

description: Modules to be imported before loading components. Stuff like reset.css, polyfills, etc.


key: rendererUrl

description: Required when renderer doesn't run on the same port (or host) as the Playground. Useful for integrations with build tools. [default: null]


key: dom

description: DOM-related options


key: containerQuerySelector

description: Document selector for existing element to use as component parent (eg. #root). A blank container element is created from scratch if no selector is provided. [default: null]


key: vite

description: Vite-related options


key: configPath

description: Path to Vite config. Set to false to disable reading it from the default path. [default: "vite.config.js"]


key: indexPath

description: Path to index module (eg. "src/my-index.tsx"). [default: matches common index/main module paths]


description: Vite renderer port. [default: 5050]


key: webpack

description: Webpack-related options


description: Path to an existing webpack config, which Cosmos will reuse to build your code. Set to null to disable this behavior. [default: "webpack.config.js"]


key: overridePath

description: Path to a user module that customizes the webpack config used by Cosmos. Set to null to disable this behavior. [default: "webpack.override.js"]


key: includeHashInOutputFilename

description: Changes output filename from "[name].js" to "[name].[contenthash].js". [default: false]


key: hotReload

description: Enable webpack's Hot Module Replacement. [default: true]


key: reloadOnFail

description: When using webpack's Hot Module Replacement, enable automatic location reload after webpack fails to update modules. [default: false]


key: ui

description: UI plugin options

required: label width height


key: devices

description: List of device viewports


key: full

description: Json schema version for the vEnvironment configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.


description: Include a different file (similar to #include of the c preprocessor). The order of includes does not matter. Circular / multiple includes are resolved correctly.


description: List of scenarios with the option to define / override variables or defines.


description: List of variables to be used in this configuration file.

value: implicit-type

var

type: float

value: path/to/somewhere

type: path

type: uint


description: List of defines to be passed to capl / vcdl. Entries can be deactivated with when.

type: array

when: SCENARIO_NAME == "my_scenario_name"


description: Global settings for all scenarios.

type: string

enum: use-network use-database use-frame use-node

const: as-fast-as-possible

default: as-fast-as-possible

default: internal-realtime

const: internal-scaled

const: internal-realtime

const: external-software

access-mode: network-based

access-mode: channel-based

signal-updates: always

time-source: internal-realtime

time-source: internal-scaled

time-scaling-factor: as-fast-as-possible

database-dotnet-namespace-generation: use-network ${someVariable}


key: database-dotnet-namespace-generation

description: User defined settings for namespace generation in the .Net typelib. Default complies with the setting "Automatic Qualification". With this setting the namespaces for signals are automatically generated so that each class is unique. For each frame a class is generated in the namespace "NetworkDB.Frames".

examples: use-network use-database use-frame use-node


key: time-scaling-factor

description:
'number': The measurement is slowed-down by this factor. For scaling factors between zero and one, the simulation is accelerated accordingly. For example, if you enter the value 0.1 the measurement is accelerated by a factor of 10.
'as-fast-as-possible': Run the simulation as fast as possible. The simulation speed is not constant and depends on the performance of the computer and the load that is provoked by simulation.


key: time-source

description:
Time source for the simulation. Operate without hardware and simulate all buses completely.
'internal-realtime': The time response of the measurement (time basis) is controlled internally.
'external-software': The time response of the measurement (time basis) is controlled by an external program.
'internal-scaled': The simulation speed is provided through the property time-scaling-factor.


description: A lists of system variables to be used by the simulation. Entries can be deactivated with when.


description: List of databases. Entries can be deactivated with when.


description: List of CAN networks. Entries can be deactivated with when.

mapping: internal-simulator

when: SCENARIO_NAME == "another_scenario"


description: List of CANFD networks. Entries can be deactivated with when.

mode: iso


description: List of Ethernet networks. Entries can be deactivated with when.

database: DB

mapping: external-sil-kit

address-configuration: static

address-configuration: dhcp


description: List of FlexRay clusters. Entries can be deactivated with when.


description: List of LIN networks. Entries can be deactivated with when.


description: A list of simulation nodes used in a simulation. Entries can be deactivated with when.

mynode

when: SCENARIO_NAME == "my_scenario_name1"

when: SCENARIO_NAME == "my_scenario_name2"


description: The definition of datasources used by application models. Input files can be deactivated with when.

type: object


description: List of application models representing some program. Entries can be deactivated with when.


description: Lists of programming modules to be used by the simulation. Entries can be deactivated with when.


description: List of user files. Entries can be deactivated with when.


description: List of XCP configuration files (entries can be deactivated with when)


description: FDX settings. Entry can be deactivated with when.

required: transport-layer port

type: integer


key: transport-layer

description: Protocol to be used as transport layer for the FDX protocol


key: port

description: Number of the UDP or TCP port to be used for the FDX protocol


key: description-files

description: List of XML files that describe which signals or variables are to be exchanged and the manner in which this is to occur (e.g., with regard to grouping). Each entry can be deactivated with when.


description: List of functional mockup units. Entries can be deactivated with when.


description: SIL Kit settings. Entry can be deactivated with when.


key: registry-uri

description: The URI of the registry.


key: participant-name

description: Name used by the simulation tool to join a simulation as a participant at the start of a measurement.


key: simulation-step-in-micro-sec

description: Time length of a single simulation step. Valid only for the time-source "external-software".


key: life-cycle-event-timeout-in-sec

description: Maximum waiting time for the other simulation participants. Valid only for the time-source "external-software".


description: Configuration of the logging for the environment.

default: application-layer bus diagnostic internal statistic system-variable test

logging-events: bus diagnostic internal ${someVariable}


description: List of CAN replay blocks. Entries can be deactivated with when.


description: List of ethernet replay blocks. Entries can be deactivated with when.


description: List of LIN replay blocks. Entries can be deactivated with when.


description: Json schema version for the vEnvironment configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.


description: Global settings for all scenarios.

type: number


description: User defined settings for namespace generation in the .Net typelib. Default complies with the setting "Automatic Qualification"


description:
Time source for the simulation. Operate without hardware and simulate all buses completely.
'internal-realtime': The time response of the measurement (time basis) is controlled internally.
'external-software': The time response of the measurement (time basis) is controlled by an external program.
'internal-scaled': The simulation speed is provided through the property time-scaling-factor.


description: The measurement is slowed-down by this factor. For scaling factors between zero and one, the simulation is accelerated accordingly. For example, if you enter the value 0.1 the measurement is accelerated by a factor of 10.


description: Run the simulation as fast as possible. The simulation speed is not constant and depends on the performance of the computer and the load that is provoked by simulation.


description: A list of simulation nodes used in a simulation. Entries can be deactivated with when.


description: List of CAN networks. Entries can be deactivated with when.


description: List of CANFD networks. Entries can be deactivated with when.


description: List of Ethernet networks. Entries can be deactivated with when.


description: List of LIN networks. Entries can be deactivated with when.


description: Global settings for all scenarios.


description: Time source for the simulation.


description: Operate without hardware and simulate all buses completely. The time response of the measurement (time basis) is controlled internally.


description: Operate without hardware and simulate all buses completely. The time response of the measurement (time basis) is controlled by an external program.


description: Operate without hardware and simulate all buses completely. The simulation speed is provided through the property time-scaling-factor.


description: List of variables to be used in this configuration file.


description: List of application models representing some program. Entries can be deactivated with when.


description: The definition of datasources used by application models. Input files can be deactivated with when.


description: List of functional mockup units. Entries can be deactivated with when.


description: SIL Kit settings. Entry can be deactivated with when.


description: registry URI


description: Name used by CANoe4SW to join a simulation as a participant at the start of a measurement.


description: Time length of a single simulation step. Valid only for the time-source "external-software". Default: 100 us.


description: Maximum waiting time for the other simulation participants. Valid only for the time-source "external-software". Default: 30s.


description: List of XCP configuration files (entries can be deactivated with when)


description: Configuration of the standalone logging block.

default: bus diagnostic internal statistic system-variable test


description: A list of simulation nodes used in a simulation. Entries can be deactivated with when.

database: mydatabase

node: mynode


description: List of databases. Entries can be deactivated with when.


description: List of CAN networks. Entries can be deactivated with when.


description: List of CANFD networks. Entries can be deactivated with when.


description: List of Ethernet networks. Entries can be deactivated with when.


description: List of CAN replay blocks. Entries can be deactivated with when.


description: List of ethernet replay blocks. Entries can be deactivated with when.


description: List of scenarios with the option to define / override variables or defines.


description: Json schema version for the vEnvironment configuration file. Acceptance criteria: equal major version, less/equal minor and patch version.


description: Include a different file (similar to #include of the c preprocessor). The order of includes does not matter. Circular / multiple includes are resolved correctly.


description: List of application models representing some program. Entries can be deactivated with when.


description: List of defines to be passed to capl / vcdl. Entries can be deactivated with when.


description: A scenario with the option to define / override variables or defines.

const: Default


key: name

description: A C-identifier for this variable (case sensitive).


key: from-environment

description: Take the value from a system environment variable.

type: boolean


description: This variable can be used in any other node and overwritten by a scenario.

required: value name

required: type name

const: int

const: uint

enum: string path

const: bool

const: float


description: Variable of type implicit type (string, number or bool).


description: Variable of type integer.


description: Variable of type unsigned integer.


description: Variable of type string or path.


description: Variable of type bool.


description: Variable of type float.


description: Defines to be passed to capl / vcdl.


key: access-mode

description: Mode of the underlying Ethernet bus. Classic approach is the 'Channel-based' setup.       More recent and recommended mode is the switched 'Network-based' mode (port based).

enum: network-based channel-based

default: network-based

examples: network-based channel-based


key: signal-updates

description: Specifies how signals are updated on Network-based access. Will be ignored on Channel-based setups. Always: Events of all ports are used to update a signal without qualified ethernet port. rx-only: Only packets received by the interface are used, which leads to less duplicated updates. never: Signals without qualified ethernet ports are not updated.

const: always

const: rx-only

const: never

examples: always rx-only never


description: Events of all ports are used to update a signal without qualified ethernet port.


description: Only packets received by the interface are used, which leads to less duplicated updates.


description: Signals without qualified ethernet ports are not updated.


description: These settings control the interpretation of frames and PDUs of FlexRay configurations with channels A and B.

enum: A B A&B no-postfixes

default: A&B

postfixes-for-ambiguous-pdus-on-channel: no-postfixes