meta.schema.json

description: permissible values for the relationship between an element and an alias

title: AliasPredicateEnum

description: an attributed description

description: text of an attributed description

description: the source of an attributed description

required: source description

title: AltDescription

description: an attributed description

description: text of an attributed description

description: the source of an attributed description

title: AltDescription

description: a tag/value pair with the semantics of OWL Annotation

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

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

description: a tag associated with an extension

description: the actual annotation

required: tag value

title: Annotation

description: a tag associated with an extension

description: the actual annotation

title: Annotation

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

$ref: #/$defs/AnonymousClassExpression

description: text of an attributed description

description: A sourced alternative description for an element

description: holds if at least one of the expressions hold

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

description: Controlled terms used to categorize an element.

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

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

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

format: date-time

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

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.

description: holds if only one of the expressions hold

description: example usages of an element

$ref: #/$defs/Example

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.

description: A primary parent class or slot from which inheritable metaslots are propagated from. While multiple inheritance is not allowed, mixins can be provided effectively providing the same thing. The semantics are the same when translated to formalisms that allow MI (e.g. RDFS/OWL). When translating to a SI framework (e.g. java classes, python classes) then is a is used. When translating a framework without polymorphism (e.g. json-schema, solr document schema) then is a and mixins are recursively unfolded

description: Keywords or tags used to describe the element

description: time at which the element was last updated

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.

description: holds if none of the expressions hold

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

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

description: expresses constraints on a group of slots for a class expression

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

description: status of the element

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

$ref: #/$defs/StructuredAlias

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

description: Outstanding issues that needs resolution

title: AnonymousClassExpression

description: An enum_expression that is not named

description: the identifier of an enumeration code set.

description: the version tag of the enumeration code set

description: the version identifier of the enumeration code set

description: A list of identifiers that are used to construct a set of permissible values

description: An enum expression that yields a list of permissible values that are to be included, after subtracting the minus set

$ref: #/$defs/AnonymousEnumExpression

description: An enum definition that is used as the basis to create a new enum

$ref: #/$defs/MatchQuery

description: Specifies a match query that is used to calculate the list of permissible values

description: An enum expression that yields a list of permissible values that are to be subtracted from the enum

description: A list of possible values for a slot range

$ref: #/$defs/PvFormulaOptions

description: Defines the specific formula to be used to generate the permissible values.

$ref: #/$defs/ReachabilityQuery

description: Specifies a query for obtaining a list of permissible values based on graph reachability

title: AnonymousEnumExpression

description: the value of the slot is multivalued with all members satisfying the condition

description: holds if all of the expressions hold

description: text of an attributed description

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: 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

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: example usages of an element

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

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

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.

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

description: agent that modified the element

description: holds if none of the expressions hold

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

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

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

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

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

description: status of the element

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

description: an encoding of a unit

description: 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)

title: AnonymousSlotExpression

description: A type expression that is not a top-level named type definition. Used for nesting.

description: holds if all of the expressions hold

description: holds if none of the expressions hold

description: an encoding of a unit

title: AnonymousTypeExpression

title: Anything

description: an element whose instances are complex objects that may have slot-value assignments

description: Indicates the class or slot cannot be directly instantiated and is intended for grouping purposes.

description: holds if all of the expressions hold

description: text of an attributed description

description: Used to extend class or slot definitions. For example, if we have a core schema where a gene has two slots for identifier and symbol, and we have a specialized schema for my_organism where we wish to add a slot systematic_name, we can avoid subclassing by defining a class gene_my_organism, adding the slot to this class, and then adding an apply_to pointing to the gene class. The new slot will be 'injected into' the gene class.

description: Inline definition of slots

description: If true then all direct is_a children are mutually disjoint and share no instances in common

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

description: The collection of classification rules that apply to all members of this class. Classification rules allow for automatically assigning the instantiated type of an instance.

description: An established standard to which the element conforms.

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: The combination of is a plus defining slots form a genus-differentia definition, or the set of necessary and sufficient conditions that can be transformed into an OWL equivalence axiom

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

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

description: example usages of an 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

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: An element in another schema which this element instantiates.

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

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

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.

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

description: agent that modified the element

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: holds if none of the expressions hold

description: true if this class represents a relationship rather than an entity

description: the collection of rules that apply to all members of this class

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

description: the refinement of a slot in the context of the containing class definition.

description: collection of slot names that are applicable to a class

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: DEPRECATED -- rdfs:subClassOf to be emitted in OWL generation

description: Indicates that this is the Container class which forms the root of the serialized document structure in tree serializations

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

description: A collection of named unique keys for this class. Unique keys may be singular or compound.

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.

title: ClassDefinition

description: holds if all of the expressions hold

description: text of an attributed description

description: Inline definition of slots

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: example usages of an element

description: agent that modified the element

description: holds if none of the expressions hold

description: status of the element

title: ClassDefinition

description: A rule that applies to instances of a class

description: text of an attributed description

description: in addition to preconditions entailing postconditions, the postconditions entail the preconditions

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: a deactivated rule is not executed by the rules engine

description: an expression that must hold for an instance of the class, if the preconditions no not hold

description: example usages of an element

description: agent that modified the element

description: if true, the the postconditions may be omitted in instance data, but it is valid for an inference engine to add these

description: an expression that must hold for an instance of the class, if the preconditions hold

description: an expression that must hold in order for the rule to be applicable to an instance

description: status of the element

title: ClassRule

description: an element whose instances must be drawn from a specified set of permissible values

description: text of an attributed description

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

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

description: example usages of an element

description: A collection of secondary parent classes or slots from which inheritable metaslots are propagated from.

description: agent that modified the element

description: status of the element

title: EnumDefinition

description: text of an attributed description

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: example usages of an element

description: agent that modified the element

description: status of the element

title: EnumDefinition

description: An expression that constrains the range of a slot

title: EnumExpression

description: usage example and description

description: description of what the value is doing

description: direct object representation of the example

description: example value

title: Example

description: a tag/value pair used to add non-model information to an entry

description: a tag associated with an extension

description: the actual annotation

title: Extension

description: a tag associated with an extension

description: the actual annotation

title: Extension

description: an expression describing an import

description: text of an attributed description

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: example usages of an element

description: The value assigned for a setting

description: agent that modified the element

description: status of the element

title: ImportExpression

description: an attributed label

description: the ncname of the source of the name

title: LocalName

description: an attributed label

description: the ncname of the source of the name

title: LocalName

description: A query that is used on an enum expression to dynamically obtain a set of permissivle values via a query that matches on properties of the external concepts

description: A regular expression that is used to obtain a set of identifiers from a source_ontology to construct a set of permissible values

description: An ontology or vocabulary or terminology that is used in a query to obtain a set of permissible values

title: MatchQuery

description: An expression that describes an abstract path from an object to another through a sequence of slot lookups

description: holds if all of the expressions hold

description: text of an attributed description

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: example usages of an element

description: in a sequential list, this indicates the next member

description: agent that modified the element

description: holds if none of the expressions hold

description: true if the slot is to be inversed

description: status of the element

description: the slot to traverse

title: PathExpression

description: a regular expression pattern used to evaluate conformance of a string

description: text of an attributed description

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: example usages of an element

description: if true then the pattern is first string interpolated

description: agent that modified the element

description: if true then the pattern must match the whole string, as if enclosed in ^...$

description: status of the element

description: the string value of the slot must conform to this regular expression expressed in the string. May be interpolated.

title: PatternExpression

description: a permissible value, accompanied by intended text and an optional mapping to a concept URI

description: text of an attributed description

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: example usages of an element

description: the value meaning of a permissible value

description: agent that modified the element

description: status of the element

description: The actual permissible value itself

description: an encoding of a unit

title: PermissibleValue

description: text of an attributed description

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: example usages of an element

description: agent that modified the element

description: status of the element

description: The actual permissible value itself

description: an encoding of a unit

title: PermissibleValue

description: prefix URI tuple

description: The prefix components of a prefix expansions. This is the part that appears before the colon in a CURIE.

description: The namespace to which a prefix expands to.

title: Prefix

description: prefix URI tuple

title: Prefix

description: enumeration of conditions by which a slot value should be set

title: PresenceEnum

description: The formula used to generate the set of permissible values from the code_set values

title: PvFormulaOptions

description: A query that is used on an enum expression to dynamically obtain a set of permissible values via walking from a set of source nodes to a set of descendants or ancestors over a set of relationship types

description: True if the query is reflexive

description: True if the reachability query should only include directly related nodes, if False then include also transitively connected

description: A list of relationship types (properties) that are used in a reachability query

description: A list of nodes that are used in the reachability query

description: True if the direction of the reachability query is reversed and ancestors are retrieved

title: ReachabilityQuery

description: enumeration of roles a slot on a relationship class can play

enum: SUBJECT OBJECT PREDICATE NODE OTHER_ROLE

title: RelationalRoleEnum

description: A collection of definitions that make up a schema or a data model.

description: text of an attributed description

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

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: 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.

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

description: example usages of an element

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

description: The official schema URI

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

description: license for the schema

description: Version of the metamodel used to load the schema

description: agent that modified the element

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

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

description: The value assigned for a setting

description: A collection of global variable settings

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

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

description: status of the element

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

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

description: particular version of schema

title: SchemaDefinition

description: assignment of a key to a value

description: the variable name for a setting

description: The value assigned for a setting

title: Setting

description: assignment of a key to a value

description: the variable name for a setting

description: The value assigned for a setting

title: Setting

description: an element that describes how instances are related to other instances

description: the name used for a slot in the context of its owning class.  If present, this is used instead of the actual slot name.

description: holds if all of the expressions hold

description: text of an attributed description

description: If s is antisymmetric, and i.s=v where i is different from v, v.s cannot have value i

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

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

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

description: An inlined enumeration

description: example usages of an element

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

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

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

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

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

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

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

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

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

description: agent that modified the element

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

description: holds if none of the expressions hold

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

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

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

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

description: transitive_form_of including the reflexive case

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

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

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.

description: status of the element

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.

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

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: an encoding of a unit

description: The name of the slot referenced in the slot_usage

title: SlotDefinition

description: holds if all of the expressions hold

description: text of an attributed description

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: An inlined enumeration

description: example usages of an element

description: true if this slot is a grouping slot

description: agent that modified the element

description: holds if none of the expressions hold

description: status of the element

description: an encoding of a unit

title: SlotDefinition

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

description: text of an attributed description

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

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: example usages of an element

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

description: agent that modified the element

description: The relationship between an element and its alias.

description: status of the element

title: StructuredAlias

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

description: text of an attributed description

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: example usages of an element

description: agent that modified the element

description: status of the element

title: SubsetDefinition

description: text of an attributed description

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: example usages of an element

description: agent that modified the element

description: status of the element

title: SubsetDefinition

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

description: holds if all of the expressions hold

description: text of an attributed description

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

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: example usages of an element

description: agent that modified the element

description: holds if none of the expressions hold

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

description: status of the element

description: A parent type from which type properties are inherited

description: an encoding of a unit

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

title: TypeDefinition

description: holds if all of the expressions hold

description: text of an attributed description

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: example usages of an element

description: agent that modified the element

description: holds if none of the expressions hold

description: status of the element

description: an encoding of a unit

title: TypeDefinition

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

description: text of an attributed description

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.

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: example usages of an element

description: agent that modified the element

description: status of the element

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.

title: UniqueKey

description: text of an attributed description

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: example usages of an element

description: agent that modified the element

description: status of the element

description: name of the unique key

title: UniqueKey

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).

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)

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

description: name of the unit encoded as a symbol

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

title: UnitOfMeasure

description: text of an attributed description

description: agent that contributed to the element

description: agent that created the element

description: time at which the element was created

description: example usages of an element

description: The official schema URI

description: license for the schema

description: agent that modified the element

description: The value assigned for a setting

description: status of the element

description: particular version of schema

title: meta


ssh-agent-config.json

title: AgentConfig

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.

type: object

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

type: array

$ref: #/definitions/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.

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

type: string

description: Can be either an item UUID or name

description: Can be either a vault UUID or name


web-manifest-combined.json

JSON schema for Web Application manifest files


grunt-task.json

$ref: #/definitions/fileFormat

$ref: #/definitions/dynamic

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

type: boolean

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

description: Destination path prefix.

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

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

enum: first last

default: first

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

enum: isFile isDirectory isBlockDevice isCharacterDevice isSymbolicLink isFIFO isSocket

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

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'.

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.

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

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

type: array string

title: JSON schema for any Grunt task


debugsettings.json

$ref: #/definitions/content

description: An absolute path to the to the executable.

description: The name of the command to call.

description: The name of the debug profile

description: The arguments to pass to the command.

description: Sets the working directory of the command.

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

description: The relative URL to launch in the browser.

format: uri

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

description: Sets the version of the SDK.

description: A list of debug profiles

$ref: #/definitions/profile

title: JSON schema for the ASP.NET DebugSettings.json files.


schema-org-thing.json

$comment: Version 1.1

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

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.

description: An alias for the item.

description: A description of the item.

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.

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

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.

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

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.

description: URL of the item.

title: JSON schema for schema.org / Thing


journey-map.schema.json

description: 图表配置

description: 旅程图主色风格

description: 每个部分的高度

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

enum: action chance emotion painPoint stage thought

description: 显示旅程图标题

type: number

description: 用户行为类型

description: 展示颜色

description: 说明

description: 情绪得分

type: integer

description: 行为名称

description: 痛点

description: 想法

description: YML 的阶段类型

description: 该阶段所有用户行为

$ref: #/definitions/UserAction

description: 展示颜色

description: 阶段名称

description: 痛点

description: 想法

required: actions name

description: 解析后的 YML 数据

$ref: #/definitions/Config

description: 配置参数

description: 步骤

$ref: #/definitions/YMLStage

description: 标题名


sergen.json

title: Table

required: Tablename Identifier Module PermissionKey

description: Table name

description: Row identifier without Row suffix

description: Module name

description: Permission key

title: Connection

description: Key of connection

description: Connection string

description: Provider name

title: Dialect

description: Dialect

title: Tables

description: Generated table information

$ref: #/definitions/Table

description: Serenity code generator (sergen) configuration

title: Extends

description:
If specified, the settings in this file extends settings in a base file similar to tsconfig.json
You can also use Sergen defaults by specifying this like "defaults@x.y.z"

description: The root namespace for the target project. It is recommended to have this in sergen.json. If not there, it will be auto calculated from root namespace in CSPROJ file, or derived from project file name by removing .Web suffix. Generated code will be placed under this namespace and project's own types are assumed to be under this namespace as well

description: If true, generated code will declare and use jFKTable type of constants for expressions in entities

description: If true, enables RowTemplate class generation. This should only be used when Serenity.Pro.Coder is enabled in the project

title: EndOfLine

description: End of line character to use in generated files. If not specified, it will be auto detected from the environment

enum: LF CRLF

description: If true, generated code will use file scoped namespaces

description: If true, generated code will parse global usings from the current project

description: If specified, generated code will assume these usings are in global using scope

description: If specified, generated code will assume these usings are not in global using scope even if they are in global using scope

description: If true, the default schema name, e.g. "dbo" for SQL Server won't be emitted in generated field expressions in Row.cs files. This is true by default only for MySql as in MySql schema names are actually database names

description: If true, instead of using [Expression] attributes for foreign view fields, it will use Origin(nameof(jFK), nameof(FKRow.ViewField)) if the FKRow is already generated in the project. It will also use ForeignKey(typeof(FKRow)) type of foreign keys instead of strings

description: If true, generated table options like Identity, Module etc. will be saved to the Connections array in sergen.json after code generation. Default is true

title: ClientTypes

description: Client types code generation related configuration

description: The output directory for generated client types .cs files

description: If false, the client types source generator in Serenity.Pro.Coder will be disabled

title: MVC

description: MVC (e.g. view locations) related configuration

description: If true, generated MVC views will be placed under the root namespace of the project

description: The output directory for MVC.cs

description: View paths to search for, defaults to "Modules" and "Views". "ProjectName" is used instead of "Modules" if Razor SDK is used  for the project, e.g. a Razor class library

description: Strip view paths from generated files. Defaults to "Modules", "Views". E.g. a subclass for Modules and Views won't be generated

description: If false, the view paths source generator in Serenity.Pro.Coder will be disabled

title: ServerTypings

description: Server typings code generation related configuration

description: Assemblies for server typings generation. Specify only if Sergen can't auto determine your project output file

description: The output directory for generated server typings files

description: If true, local texts will be generated

description: If true, module re-exports will be generated. Defaults to true

description: If true, module typings will be generated. Defaults to true if you have "module" defined in tsconfig.json

description: If true, namespace typings will be generated. Defaults to true if you don't have "module" defined in tsconfig.json

description: If false, the server typings source generator in Serenity.Pro.Coder will be disabled

title: Restore

description: Sergen restore command related configuration

description: List of files (git ignore like) to include while restoring

description: List of files (git ignore like) to exclude while restoring

description: Set false to disable namespace typings restore to typings/ folder

title: TSBuild

description: List of entry point globs, default is "**/Page.ts", "**/ScriptInit.ts"

description: Should the list of entry points, e.g. ESM be generated, only available with Serenity.Pro.Coder

title: Connections

description: List of connections. It is only needed when it is desired to work / generated code based on a connection string that is not in appsettings.json

$ref: #/definitions/Connection

description: Path to KDiff3 executable. If not specified, it will be auto detected from the environment. (deprecated)

description: Full path to TypeScript compiler. It is assumed to be in path if not specified

title: BaseRowClasses

description: The base class name

description: The base class fields that should exists in a table for this base class to be used

title: ForeignFieldSelection

description: The set of foreign fields to generate, default is NameOnly

enum: None All NameOnly

description: A list of foreign fields to include in generated code. This could be used to include some additional fields This could be used to include some additional fields. Not so useful if ForeignFieldSelection is All

description: A list of foreign fields to omit from generated code. This could be used to disable generating code for join fields like CreatedBy, ModifiedBy etc, so properties like CustomerCreatedBy, CustomerModifiedBy etc. won't be generated in OrderRow. Not so useful if ForeignFieldSelection is None or NameOnly

description:
The location of custom templates folder. The files in this folder will override the default scriban templates in Sergen. You may also include additional files to be generated. Their names must match the names at
https://github.com/serenity-is/Serenity/tree/master/src/Serenity.Net.CodeGenerator/Templates

title: CustomGenerate

description: The relative paths of custom generated files

title: CustomSettings

description: Custom settings to be passed to and used in custom templates

description: The list of appsettings.json files in order. Default is appsettings.json, appsettings.machine.json

title: UpgradeInfo

description: The upgrade / migration related information used by stargen to determine the base version of template used, and already applied upgrades

title: InitialType

description: Initial type of project. Available options are "Community" e.g. Serene, "Premium" e.g. StartSharp

enum: Community Premium

description: Version this project is created from. Used to determine which migrations should be applied to project (starting from)

title: InitialVersion

title: AppliedUpgrades

description: List of already applied upgrades if any

title: Serenity Code Generator (sergen) Configuration


zuul.json

$ref: #/definitions/JobModel

title: JobEntry

title: Abstract

title: Allowed-Projects

title: Ansible-Version

title: Attempts

title: Branches

title: Description

$ref: #/definitions/JobDependencyModel

title: Files

title: Failure-Url

title: Files

title: Final

title: Host-Vars

title: Irrelevant-Files

title: Name

title: Nodeset

title: Override-Checkout

title: Parent

title: Post-Run

title: Post-Timeout

title: Pre-Run

title: Provides

$ref: #/definitions/RequiredProjectModel

title: Required-Projects

title: Requires

$ref: #/definitions/ZuulRoleModel

title: Roles

title: Run

$ref: #/definitions/JobSecretModel

title: Secrets

title: Success-Url

title: Tags

title: Timeout

title: Vars

title: Voting

title: Workspace Scheme

enum: flat golang unique

title: JobModel

title: Name

title: Soft

title: JobDependencyModel

title: Name

title: Pass-To-Parent

title: Secret

required: name secret

title: JobSecretModel

title: Jobs

title: Queue

title: PipelineModel

$ref: #/definitions/ProjectModel

title: ProjectEntry

$ref: #/definitions/PipelineModel

title: Default-Branch

title: Description

title: Name

title: Queue

title: Templates

title: Vars

title: ProjectModel

$ref: #/definitions/ProjectTemplateModel

title: ProjectTemplateEntry

title: Default-Branch

title: Description

title: Name

title: Queue

title: Vars

title: ProjectTemplateModel

title: Name

title: Override-Checkout

title: RequiredProjectModel

title: SecretEntry

title: Data

title: Name

title: SecretModel

title: Zuul

title: ZuulRoleModel

title: Zuul Config Schema


all-contributors.json

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

title: Name of the project

title: Name of the user the project is hosted by

title: Type of repository

enum: github gitlab

default: github

title: Points to the repository hostname

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

title: Array of files to update

title: Size (in px) of the user's avatar

title: Auto-commit badge when adding contributors

title: Commit convention

enum: angular atom ember eslint jshint gitmoji none

default: angular

title: Maximum number of columns for the contributors table

title: true: Sort alphabetically. false: Display in order of addition.

title: Your own lodash template to generate the badge

title: Your own lodash template to generate the contributor

title: Custom symbols or link templates for contribution types (can override the documented types)

title: Symbol to use for the contribution type

title: Description of the contribution type

title: Link to use for the contribution type

title: Adds a footer with link to usage

title: Makes the CI ignore the commit

title: List of contributors for this project

title: Username of the contributor

title: Name of the contributor

title: URL of the contributor's avatar

title: URL of the contributor's profile

title: Array of contributions made by the contributor

required: projectName projectOwner

title: All Contributors configuration file


package.json

title: JSON schema for NPM package.json files

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

type: object string

format: email

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.

description: Run AFTER the package is installed.

x-intellij-language-injection: Shell Script

description: Run AFTER the package is published.

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

description: Run by the 'npm start' command.

description: Run by the 'npm stop' command.

description: Run by the 'npm test' command.

description: Run BEFORE the package is uninstalled.

description: Run BEFORE bump the package version.

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

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.

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

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.

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

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

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

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

$ref: #/definitions/packageExportsEntryPath

$ref: #/definitions/packageExportsEntryObject

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

$ref: #/definitions/packageExportsEntry

$ref: #/definitions/packageExportsFallback

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

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

$ref: #/definitions/fundingUrl

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

description: The name of the package.

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

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

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

description: The url to the project homepage.

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.

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

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

$ref: #/definitions/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.

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'.

$ref: #/definitions/person

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

description: A list of people who maintains this package.

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.

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

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.

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

type: string object

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

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

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

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

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.

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

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

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

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

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.

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

$ref: #/definitions/fundingWay

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.

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

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

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.

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

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

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

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

description: Run BEFORE the package is installed.

description: Run AFTER the package is uninstalled.

description: Run AFTER bump the package version.

description: Start dev server to serve application files

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

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.

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

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

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

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

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

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

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

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

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.

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

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

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

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.

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


dein.json

title: Pattern for a definition of vim plugin

title: repository.

description: The repository URI or local repository directory path.

$ref: #/definitions/Url

$ref: #/definitions/Path

$ref: #/definitions/repo-string-pattern

description: An augroup name that the plugin uses for |VimEnter| or |GUIEnter| autocmd events.

description: Specify the build script. This command is executed by |system()| in the plugin runtimepath. Note: In previous versions of dein, build could also be of type dictionary, but that is now deprecated. Please use |dein-options-hook_post_update| instead.

description: Specify a list of plugins a plugin depends on. List items are '{plugin-name}'. Those specified in the list are NOT installed automatically. Note: The loading order is not guaranteed in non lazy plugins.

$ref: #/definitions/ArrayOrString

description: If set to v:true, dein doesn't update it automatically. It is useful for outdated plugins that can no longer be updated.

$ref: #/definitions/Boolean

title: all filetypes

description: '_' key is executed after all ftplugin.

title: filetype

description:
'{filetype}' key is executed {filetype} ftplugin.
You can define multiple filetypes by '{filetype1}_{filetype2}' key.
'b:undo_ftplugin' is defined automatically.

description: If set to v:false, dein doesn't register the plugin, i.e. the plugin will be disabled. If it is String, dein will eval it. If you don't set it, dein will register (enable) the plugin

description: If set to v:true, dein doesn't add the path to 'runtimepath' automatically. If you don't set it, dein will set it automatically when the conditions are met. Note: You should not specify the plugins which have no 'plugin/' directory as lazy load plugins.  It is meaningless and just increases the overhead.  You can get the no meaning lazy plugins by |dein#check_lazy_plugins()|.

description: If set to v:false, dein doesn't merge the plugin directory. It is useful for the plugin files conflicts.

description: If set to v:true, dein merge the plugin "ftdetect" directory. It is useful to enable file detection when lazy loaded plugin. Note: It does not work if ftdetect script depends on lazy plugin functions.

description: Specify the name of the plugin. This is used for dein management and other functions. If it is omitted, the tail of the repository name will be used. Note: Must be unique across the all plugin. If the plugin name conflicts with another plugin, dein will overwrite the previous settings with the new one. If the repo tail is bound to conflict, you can set the 'name' option manually to prevent overwriting an existing plugin setting.

description: Specify the normalized name of the plugin.  If omitted, dein will normalize the tail of the repository name. Note: Must be unique across all plugins.

description: If it is matched to the executed command, dein will call |dein#source()|.

description: dein will call |dein#source()| on the events.

description: If it is matched to the called function, dein will call |dein#source()|.

description: If it is matched to 'filetype', dein will call |dein#source()|.

description: If it is evaluated and it is non-zero, dein will call|dein#source()|.The default evaluate timings are 'BufRead', 'BufNewFile','VimEnter' and 'FileType'.If |dein-options-on_event| exists, it is evaluated when|dein-options-on_event|.

description: If it is matched to the required lua module root, dein will call |dein#source()|. Note: It is for neovim only. Note: It does not work for neovim standard modules.

description: If it is the Dictionary, the key is {mode} and the items are{mapping} or [{mapping1}, {mapping2}, ...].If it is the List, the items are {mapping} or [{mode},{mapping1}, [{mapping2}, ...]].If {mode} is omitted, 'nx' is used.

description: If set to '.*', dein will call |dein#source()| on editing allfiles.  Otherwise, dein will call |dein#source()| if thebuffer name is matched to the string pattern.Note: It is useful for explorer behavior plugins.

description: If set to v:true, dein overwrite existing plugin config when |dein#add()|.

description: Specify the plugin downloaded path.

description: Specify a revision number or branch/tag name. If it is '*' in 'git' type, dein will use latest released tag.You can specify the wildcards like '0.*'.Note: If the type is 'raw', rev must be hash number.

description: Specify the runtime path. You can use it when the repository has the Vim plugin in a subdirectory.For example: https://github.com/rstacruz/sparkup If it is empty string, dein will not add the path to'runtimepath'

default: vim

description: Specify the script type. It is useful for non-official categorized plugins. For example: 'indent', 'plugin', 'ftplugin', ... Note: You must not specify it for categorized plugins.

enum: indent plugin colors ftplugin

description: The time of timeout seconds when updating/installing plugins. If omit it, |g:dein#install_process_timeout| will be used.

description: If set to v:true, dein will load the plugin in 'sudo' mode. If you don't set it, dein won't load it.

description: Specify the repository type. If it is omitted, a guess is made based on {repository}.

enum: none raw git

enumValues: Raw plugin file ('script_type' attribute is needed)

description:
The history depth for 'git clone'.
 If omitted, |g:dein#types#git#clone_depth| is used. If it is than 0, dein clones the repository by shallow clone. Shallow clone feature saves your repository clone time. But it has problems in some repository.
 Note: This attribute is available in git type only.

 https://github.com/Shougo/neobundle.vim/issues/81 https://github.com/Homebrew/homebrew/issues/12024

description: It is executed after the line is parsed. Note: You cannot call plugin function in 'hook_add'. Because the plugin is not sourced when 'hook_add'.

description: It is executed after the all plugins are updated.

description: It is executed after plugins are sourced.  Note: In Vim initializing, you must call the 'hook_post_source' hooks manually in |VimEnter| if needed.

description: It is executed after the plugins are updated.

description: It is executed before plugins are sourced. Note: The 'sourced' means after |dein#end()| or when |VimEnter| or autoloaded.           'type': 'string',

description:
Lua lauguage string hook instead of Vim script.
It is converted to "hook_add" key.

description:
Lua lauguage string hook instead of Vim script.
It is converted to "hook_source" key.

title: Pattern for multiple definition of vim plugin

title: plugins

title: path

title: repo name pattern

description: If {repo} starts with github user name (ex:'Shougo/dein.vim'), dein will install github plugins.

title: path

pattern: ^[nvxsomilct]+$

description: Pattern for vim key binding. You can use plugin prefix mappings. You can use '<Plug>' keyword as {mapping}. If{mapping} is '<Plug>', '<Plug>(normalized_name' isused. linter support is now under developping

description: A schema for config of dein.vim (https://github.com/Shougo/dein.vim/blob/f93be8c/doc/dein.txt#L963)

description:
Definition properties table for installing a vim plugin.
It is converted to |dein#add()|.

$ref: #/definitions/Plugin

title: ftplugin definition

description:
'_' key is executed after all ftplugin.
'{filetype}' key is executed {filetype} ftplugin.
 You can define multiple filetypes by '{filetype1}_{filetype2}' key.

title: all filetypes

description: '_' key is executed after all ftplugin.

title: filetype

title: hook_add definition

description:
It is the global |dein-options-hook_add|.
It is executed in |dein#end()|.

title: It is converted to |dein-toml-hook_add|

description:
It is converted to |dein-toml-hook_add|
"plugins" key is needed.

$ref: #/definitions/MultiplePlugins

title: dein.vim


pre-commit-hooks.json

enum: conda coursier dart docker docker_image dotnet fail golang lua node perl python python_venv r ruby rust swift pygrep script system

enum: adobe-illustrator alpm apinotes asar asciidoc ash asm aspectj audio avif awk babelrc bash batch bats bazel bazelrc bib binary bitmap bowerrc browserslistrc bzip2 c c# c++ c2hs cbsd clojure clojurescript cmake codespellrc coffee coveragerc crystal csh cson csproj css csslintrc csv cuda cython dart dash def diff directory dockerfile dockerignore dotenv dtd editorconfig edn ejs eot eps erb executable expect file fish flake8 gdscript geojson gherkin gif gitattributes gitconfig gitignore gitlint gitmodules go go-mod go-sum gotmpl gpx graphql groovy gyb gyp gzip handlebars haskell hcl header hgrc html icalendar icns icon idl idris image inc ini inl ino inx jade jar java java-properties javascript jenkins jinja jpeg jshintrc json json5 jsonnet jsx jupyter kml kotlin ksh lean lektor lektorproject less liquid literate-haskell lua mailmap makefile manifest map markdown mdx mention-bot mib modulemap musescore myst ngdoc nim nimble nix non-executable npmignore nunjucks objective-c objective-c++ ocaml otf p12 pdbrc pdf pem perl php pkgbuild plain-text plantuml plist png pofile powershell prettierignore prisma proto puppet purescript pyi pylintrc pypirc pyproj python python2 python3 pyz qml r relax-ng rst ruby rust salt sass sbt scala scheme scss sh shell sln socket solidity spec sql stylus svelte svg swf swift swiftdeps symlink system-verilog tar tcsh terraform tex text thrift tiff toml ts tsv tsx ttf twig twisted txsprofile urdf vb vbproj vcxproj vdx verilog vhdl vim vtl vue wav webp wheel wkt woff woff2 wsgi xhtml xml xquery xsd xsl yaml yamllint yang yin zcml zig zip zpt zsh

enum: commit merge-commit push prepare-commit-msg commit-msg post-checkout post-commit post-merge post-rewrite pre-commit pre-merge-commit pre-push pre-rebase manual

$ref: #/definitions/stage

required: id name entry language

description: id of the hook - used in pre-commit-config.yaml.

description: name of the hook - shown during hook execution.

description: entry point - the executable to run. Can also contain arguments that will not be overridden such as `entry: autopep8 -i`.

description: language of the hook - tells pre-commit how to install the hook.

$ref: #/definitions/language

description: (optional) allows the hook to be referenced using an additional id.

description: (optional) the pattern of files to run on.

description: (optional) exclude files that were matched by files.

description: (optional) list of file types to run on (AND).

description: (optional) list of file types to run on (OR).

description: (optional) pattern of files to exclude.

description: (optional) a list of dependencies that will be installed in the environment where this hook gets run. One useful application is to install plugins for hooks such as eslint.

description: (optional) if true this hook will run even if there are no matching files.

description: (optional) if true, forces the output of the hook to be printed even when the hook passes.

description: (optional) if false no filenames will be passed to the hook.

description: (optional) if true this hook will execute using a single process instead of in parallel.

description: (optional) description of the hook. Used for metadata purposes only.

description: (optional) see Overriding language version at https://pre-commit.com/#overriding-language-version

default: default

description: (optional) if present, the hook output will additionally be written to a file.

description: (optional) allows one to indicate a minimum compatible pre-commit version.

description: (optional) list of additional parameters to pass to the hook.

description: (optional) confines the hook to the commit, merge-commit, push, prepare-commit-msg, commit-msg, post-checkout, post-commit, post-merge, post-rewrite, or manual stage. See Confining hooks to run at certain stages in https://pre-commit.com/#confining-hooks-to-run-at-certain-stages

$ref: #/definitions/stages


minecraft-pack-mcmeta.json

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

title: pack options

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

title: 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

title: filter options

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

title: pattern

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

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

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

title: pack metadata


linkinator-config.json

description: The number of connections to make simultaneously.

description: The config file path.

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.

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

description: Return the data in CSV or JSON format.

default: json

enum: json text csv

description: If true, does not show links

description: The output verbosity

default: error

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.

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

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

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

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.

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

description: How many times should an error be retried?

description: Random jitter applied to error retry.

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

title: JSON schema for Linkinator


cicstags.json

title: CICS region tagging file JSON Schema.

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

title: CICS region tagging file JSON Schema.

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


description: Translation key

description: Translation string

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

$ref: #/definitions/placeholders

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

$ref: #/definitions/placeholder

description: Placeholder key

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

description: (optional) example of this placeholder

$ref: #/definitions/translationEntry

title: browser.i18n messages.json translation file


unist.json

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

markdownDescription: A point represents one place in a source file. The value of the point field implements the [Point](https://github.com/syntax-tree/unist#point) interface.

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

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

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

required: column line

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.

markdownDescription: A position represents the location of a node in a source file. The value of the position field implements the [Position](https://github.com/syntax-tree/unist#position) interface. The position field must not be present if a node is generated.

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

$ref: #/definitions/Point

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

required: end start

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

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.

markdownDescription: The [type](https://github.com/syntax-tree/unist#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.

$ref: #/definitions/Position

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

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

markdownDescription: The data field represents information from the ecosystem. The value of the data field implements the [Data](https://github.com/syntax-tree/unist#data) interface.

description: The value field can contain any value.

title: JSON schema for unist syntax trees


tmlanguage.json

$ref: #/definitions/root

$ref: #/definitions/grammar

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»).

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).

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.

$ref: #/definitions/pattern

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.

$ref: #/definitions/name

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

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

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'.

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.

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.

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.

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.

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.

$ref: #/definitions/captures

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.

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.

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.

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

required: begin end

required: begin while

whileCaptures: begin while

endCaptures: begin end


drupal-config.json

title: Configuration item

$ref: #/definitions/configItem

title: The type of the value

examples: boolean integer float string uri email mapping sequence label text config_object config_entity

title: User interface label for the value

title: Whether the defined type is translatable

title: The translation context the source string belongs to

title: Whether the value can be empty

title: The class implementing parsing

title: The definition class

title: Determines how the sequence should be sorted

title: Validation constrains

title: JSON schema for Drupal configuration schema file


galaxy.json

title: CollectionVersionConstraintModel

$ref: #/$defs/SPDXLicenseEnum

title: SPDXLicense

description: An enumeration.

title: SPDXLicenseEnum

title: Authors

title: Build Ignore

title: Dependencies

title: Description

title: Documentation

title: Homepage

title: Issues

$ref: #/$defs/SPDXLicense

title: License

title: License File

markdownDescription:
A dict controlling use of manifest directives used in building the collection artifact.
The key directives is a list of MANIFEST.in style directives
The key omit_default_directives is a boolean that controls whether the default directives are used.
Mutually exclusive with build_ignore.

title: Directives

title: Omit Default Directives

title: Manifest

title: Name

title: Namespace

markdownDescription:
The path to the Markdown (.md) readme file. This path is relative to the root of the collection.
See [metadata structure](https://docs.ansible.com/ansible/latest/dev_guide/collections_galaxy_meta.html)

title: Readme

title: Repository

title: Tags

markdownDescription: Version must use [SemVer](https://semver.org/) format, which is more restrictive than [PEP-440](https://peps.python.org/pep-0440/). For example `1.0.0-rc1` is valid but `1.0.0rc` is not.

title: Version

required: namespace name version readme authors description repository

title: Ansible galaxy.yml Schema


arc-schema.json

title: DynamoDB table

title: OpenJS Architect JSON Schema

type: array object

type: string number boolean array object

$id: #/properties/app

title: @app

description: Application namespace

type: string array

$ref: #/definitions/looseName

$id: #/properties/aws

title: @aws

description: AWS specific configuration

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

type: string number

type: string object array

$id: #/properties/static

title: @static

description: Static asset & S3 configuration

enum: fingerprint folder ignore prefix production prune spa staging

type: string boolean array object

type: boolean string

$id: #/properties/ws

title: @ws

description: API Gateway WebSocket configuration

$ref: #/definitions/strictName

$id: #/properties/http

title: @http

description: API Gateway configuration

enum: any get post put patch delete head options

title: @proxy

description: Proxy

enum: testing staging production

$id: #/properties/events

title: @events

description: Events configuration

$id: #/properties/queues

title: @queues

description: Queues configuration

$id: #/properties/macros

title: @macros

description: Deployment macros configuration

$ref: #/definitions/macros

$id: #/properties/scheduled

title: @scheduled

description: Scheduled event configuration

$id: #/properties/scheduled/items

title: scheduled handlers

pattern: ^(rate|cron)

$id: #/properties/tables

title: @tables

description: DynamoDB database tables configuration

$ref: #/definitions/table

$id: #/properties/indexes

title: @indexes

description: DynamoDB global secondary indexes configuration


pyrightconfig.schema.json

description: Pyright Configuration Schema

enum: none information warning error

$id: #/properties/include

title: Files and directories included in type analysis

$id: #/properties/include/items

title: File or directory to include in type analysis

$id: #/properties/exclude

title: Files and directories excluded from type analysis

$id: #/properties/exclude/items

title: File or directory to exclude from type analysis

$id: #/properties/ignore

title: Files and directories whose diagnostics are suppressed

$id: #/properties/ignore/items

title: File or directory where diagnostics should be suppressed

$id: #/properties/strict

title: Files and directories that should use 'strict' type checking rules

$id: #/properties/strict/items

title: File or directory that should use 'strict' type checking rules

$id: #/properties/defineConstant

title: Identifiers that should be treated as constants

type: string boolean

title: Value of constant (boolean or string)

$id: #/properties/typeCheckingMode

enum: off basic strict

title: Specifies the default rule set to use for type checking

default: basic

$id: #/properties/useLibraryCodeForTypes

title: Use library implementations to extract type information when type stub is not present

$id: #/properties/typeshedPath

title: Path to directory containing typeshed type stub files

$id: #/properties/stubPath

title: Path to directory containing custom type stub files

$id: #/properties/strictListInference

title: Infer strict types for list expressions

$id: #/properties/strictSetInference

title: Infer strict types for set expressions

$id: #/properties/strictDictionaryInference

title: Infer strict types for dictionary expressions

title: Analyze and report diagnostics for functions that have no annotations

$id: #/properties/strictParameterNoneValue

title: Allow implicit Optional when default parameter value is None

$id: #/properties/enableExperimentalFeatures

title: Enable the use of experimental features that are not part of the Python typing spec

$id: #/properties/enableTypeIgnoreComments

title: Allow "# type: ignore" comments

$id: #/properties/reportGeneralTypeIssues

$ref: #/definitions/diagnostic

title: Controls reporting of general type issues

$id: #/properties/reportPropertyTypeMismatch

title: Controls reporting of property getter/setter type mismatches

$id: #/properties/reportFunctionMemberAccess

title: Controls reporting of member accesses on function objects

$id: #/properties/reportMissingImports

title: Controls reporting of imports that cannot be resolved

$id: #/properties/reportMissingModuleSource

title: Controls reporting of imports that cannot be resolved to source files

default: warning

$id: #/properties/reportMissingTypeStubs

title: Controls reporting of imports that cannot be resolved to type stub files

$id: #/properties/reportImportCycles

title: Controls reporting of module imports that create cycles in import graph

$id: #/properties/reportUnusedImport

title: Controls reporting of imported symbols that are not referenced within the source file

$id: #/properties/reportUnusedClass

title: Controls reporting of private classes that are not accessed

$id: #/properties/reportUnusedFunction

title: Controls reporting of private functions or methods that are not accessed

$id: #/properties/reportUnusedVariable

title: Controls reporting of local variables that are not accessed

$id: #/properties/reportDuplicateImport

title: Controls reporting of symbols or modules that are imported more than once

title: Controls reporting of wlidcard import from external library

$id: #/properties/reportOptionalSubscript

title: Controls reporting of attempts to subscript (index) a variable with Optional type

$id: #/properties/reportOptionalMemberAccess

title: Controls reporting of attempts to access a member of a variable with Optional type

$id: #/properties/reportOptionalCall

title: Controls reporting of attempts to call a variable with Optional type

$id: #/properties/reportOptionalIterable

title: Controls reporting of attempts to use an Optional type as an iterable value

title: Controls reporting of attempts to use an Optional type as a parameter to a with statement

$id: #/properties/reportOptionalOperand

title: Controls reporting of attempts to use an Optional type as an operand for a binary or unary operator

title: Controls reporting of attempts to access a non-required key in a TypedDict without a check for its presence

title: Controls reporting of function decorators without type annotations, which obscure function types

title: Controls reporting of class decorators without type annotations, which obscure class types

$id: #/properties/reportUntypedBaseClass

title: Controls reporting of a base class of an unknown type, which obscures most type checking for the class

$id: #/properties/reportUntypedNamedTuple

title: Controls reporting of a named tuple definition that does not contain type information

$id: #/properties/reportPrivateUsage

title: Controls reporting of private variables and functions used outside of the owning class or module and usage of protected members outside of subclasses

title: Controls reporting of deprecated type comment usage

title: Controls reporting of improper usage of symbol imported from a "py.typed" module that is not re-exported from that module

title: Controls reporting of attempts to redefine variables that are in all-caps

title: Controls reporting of use of deprecated class or function

title: Controls reporting of method overrides in subclasses that redefine the method in an incompatible way

title: Controls reporting of overrides in subclasses that redefine a variable in an incompatible way

title: Controls reporting of __init__ and __new__ methods whose signatures are inconsistent

title: Controls reporting of function overloads that overlap in signature and obscure each other or do not agree on return type

title: Controls reporting of missing call to parent class for inherited `__init__` methods

title: Controls reporting of instance variables that are not initialized in the constructor

title: Controls reporting of invalid escape sequences used within string literals

title: Controls reporting input and return parameters whose types are unknown

title: Controls reporting argument expressions whose types are unknown

title: Controls reporting input and return parameters for lambdas whose types are unknown

title: Controls reporting local variables whose types are unknown

title: Controls reporting class and instance variables whose types are unknown

title: Controls reporting input parameters that are missing a type annotation

title: Controls reporting generic class reference with missing type arguments

title: Controls reporting improper use of type variables within function signatures

title: Controls reporting usage of function calls within a default value initializer expression

title: Controls reporting calls to 'isinstance' or 'issubclass' where the result is statically determined to be always true

title: Controls reporting calls to 'cast' that are unnecessary

title: Controls reporting the use of '==' or '!=' comparisons that are unnecessary

title: Controls reporting the use of 'in' operations that are unnecessary

title: Controls reporting assert expressions that will always evaluate to true

title: Controls reporting usage of implicit concatenation of string literals

title: Controls reporting of attempts to use an unbound or possibly unbound variable

title: Controls reporting of attempts to use an undefined variable

title: Controls reporting of type stub statements that do not conform to PEP 484

title: Controls reporting of incomplete type stubs that declare a module-level __getattr__ function

title: Controls reporting of unsupported operations performed on __all__

title: Controls reporting of call expressions whose results are not consumed

title: Controls reporting of call expressions that returns Coroutine whose results are not consumed

title: Controls reporting of simple expressions whose value is not used in any way

title: Controls reporting of '# type: ignore' comments that have no effect'

title: Controls reporting of 'match' statements that do not exhaustively match all possible values

title: Controls reporting of shadowed imports of stdlib modules

title: Controls reporting overridden methods that are missing an `@override` decorator

title: Additional import search resolution paths

title: Additional import search resolution path

title: Python version to assume during type analysis

title: Python platform to assume during type analysis

title: Path to directory containing a folder of virtual environments

title: Name of virtual environment subdirectory within venvPath

title: Output verbose logging

title: Analysis settings to use for specified subdirectories of code

title: Path to code subdirectory to which these settings apply


lintstagedrc.schema.json

$ref: #/definitions/advancedConfig

$ref: #/definitions/basicConfig

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

type: object

$ref: #/definitions/linter

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

$ref: #/definitions/$schemaProperty

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

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

$ref: #/definitions/globOptions

$ref: #/definitions/lintersMap

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

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

enum: update verbose

default: update

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

enum: concurrent chunkSize globOptions linters ignore subTaskConcurrency renderer relative