jsonld.json

$ref: #/definitions/context

$ref: #/definitions/graph

$ref: #/definitions/common

description: Used to define the short-hand names that are used throughout a JSON-LD document.

type: object string array null

description: Used to express a graph.

description: Used to uniquely identify things that are being described in the document with IRIs or blank node identifiers.

description: Used to specify the data that is associated with a particular property in the graph.

type: string boolean number null

description: Used to specify the language for a particular string value or the default language of a JSON-LD document.

description: Used to set the data type of a node or typed value.

type: string null array

description: Used to set the default container type for a term.

description: Used to express an ordered set of data.

description: Used to express an unordered set of data and to ensure that values are always represented as arrays.

description: Used to express reverse properties.

type: string object null

description: Used to set the base IRI against which relative IRIs are resolved

description: Used to expand properties and values in @type with a common prefix IRI

title: Schema for JSON-LD

type: object array


drupal-info.json

const: module

title: A route name of the configuration form

type: string

type: array

$ref: #/definitions/dependency

title: Dependencies that are needed to run certain automated tests for this extension

const: theme

title: Base theme

default: classy

type: boolean

title: A list of libraries to add to all pages where the theme is active

title: A collection of libraries and assets to override

type: object

title: A collection of libraries and assets to add whenever a library is attached

title: The theme engine

default: twig

title: The path to logo relative to the theme's .info.yml

title: The path to screenshot relative to the theme's .info.yml file

title: A list of theme regions

title: A list of inherited regions to remove

title: A list of features to expose on the theme 'Settings' page

title: A list of stylesheets from other modules or themes to remove from all pages where the theme is active

title: A list of stylesheets to add to the CKEditor frame

const: profile

title: Declare the installation profile as a distribution

title: The distribution name

title: The theme for the distribution installation

title: Required modules

title: Modules to install to support the profile

title: List any themes that should be installed as part of the profile installation

title: Extension dependency

title: Machine name

title: The human-readable name

enum: module theme profile theme_engine

title: Semantic core version requirement

title: Extension description

title: A key that allows to group extension together an administrative pages

title: The version of the extension

title: The machine name of extension project on drupal.org

title: The date and time when the extension was packaged

type: integer

title: Do not the extension in admin interface

title: The minimal PHP version that is required for this extension

type: number

required: type core_version_requirement name

title: JSON schema for Drupal extension info file


foundryvtt-template.json

description: Array of strings defining the entity subtypes defined by the schema.

description: Template schemas that can be reused by entity subtypes.

description: Definition of a template schema.

description: Custom property defined for this schema.

description: Definition of an entity subtype.

description: Array of strings specifying which template schemas to apply to this type.

$ref: #/definitions/entity

description: The top level data schema for Actor types.

description: The top level data schema for Item types.

title: JSON schema for Foundry VTT template.json files.


meta-runtime.json

$ref: #/$defs/Metadata

description: See https://docs.ansible.com/ansible/devel/dev_guide/developing_collections_structure.html#meta-directory

$ref: #/$defs/ActionGroup

description: A mapping of groups and the list of action plugin and module names they contain. They may also have a special ‘metadata’ dictionary in the list, which can be used to include actions from other groups.

title: Action Groups

$ref: #/$defs/Redirect

description: A mapping of names for Python import statements and their redirected locations.

title: Import Redirection

markdownDescription: Content in a collection that Ansible needs to load from another location or that has been deprecated/removed. The top level keys of plugin_routing are types of plugins, with individual plugin names as subkeys. To define a new location for a plugin, set the redirect field to another name. To deprecate a plugin, use the deprecation field to provide a custom warning message and the removal version or date. If the plugin has been renamed or moved to a new location, the redirect field should also be provided. If a plugin is being removed entirely, tombstone can be used for the fatal error message and removal version or date.

title: Plugin Routing

title: The version of Ansible Core (ansible-core) required to use the collection. Multiple versions can be separated with a comma.

title: Ansible Meta Runtime Schema


coffeelint.json

description: Determines the error level

enum: error warn ignore

description: This rule checks to see that there is spacing before and after the arrow operator that declares a function. [default level: ignore]

$ref: #/definitions/base

description: This rule checks to see that there is the proper spacing inside curly braces. The spacing amount is specified by `spaces`. The spacing amount for empty objects is specified by `empty_object_spaces`. [default level: ignore]

description: This rule mandates that all class names are CamelCased. Camel casing class names is a generally accepted way of distinguishing constructor functions - which require the `new` prefix to behave properly - from plain old functions. [default level: error]

description: [default level: error]

description: This rule checks to see that there is spacing before and after the colon in a colon assignment (i.e., classes, objects). [default level: ignore]

description: Examine the complexity of your application. [default level: ignore]

description: Prevents defining duplicate keys in object literals and classes. [default level: error]

description: Requires constructors with no parameters to include the parens. [default level: ignore]

description: This rule makes sure that parentheses are around comprehensions. [default level: warn]

description: Checks that the file ends with a single newline. [default level: ignore]

description: This rule imposes a standard number of spaces to be used for indentation. Since whitespace is significant in CoffeeScript, it's critical that a project chooses a standard indentation format and stays consistent. Other roads lead to darkness. [default level: error]

description: This rule ensures your project uses only windows or unix line endings. [default level: ignore]

enum: unix windows

description: This rule imposes a maximum line length on your code. [default level: error]

description: Warns when you use `this` inside a function that wasn't defined with a fat arrow. This rule does not apply to methods defined in a class, since they have `this` bound to the class instance (or the class itself, for class methods). [default level: ignore]

description: Checks the number of newlines between classes and other code. [default level: ignore]

description: Backticks allow snippets of JavaScript to be embedded in CoffeeScript. While some folks consider backticks useful in a few niche circumstances, they should be avoided because so none of JavaScript's 'bad parts', like with and eval, sneak into CoffeeScript. [default level: error]

description: This rule detects the `debugger` statement. [default level: warn]

description: Disallows declaring empty functions. The goal of this rule is that unintentional empty callbacks can be detected. [default level: ignore]

description: This rule prohibits empty parameter lists in function definitions. [default level: ignore]

description: This rule prohibits implicit braces when declaring object literals. Implicit braces can make code more difficult to understand, especially when used in combination with optional parenthesis. [default level: ignore]

description: This rule prohibits implicit parens on function calls. [default level: ignore]

description: This rule prohibits string interpolation in a single quoted string. [default level: ignore]

description: This rule warns about nested string interpolation, as it tends to make code harder to read and understand. [default level: warn]

description: This rule forbids the increment and decrement arithmetic operators. Some people believe the `++` and `--` to be cryptic and the cause of bugs due to misunderstandings of their precedence rules. [default level: ignore]

description: Warns when you use the fat arrow for a private function inside a class definition scope. It is not necessary and it does not do anything. [default level: warn]

description: This rule checks that no stand alone `@` are in use, they are discouraged. [default level: ignore]

description: This rule forbids tabs in indentation. Enough said. [default level: error]

description: This rule prohibits `this`. Use `@` instead. [default level: ignore]

description: This rule forbids throwing string literals or interpolations. While JavaScript (and CoffeeScript by extension) allow any expression to be thrown, it is best to only throw `Error` objects, because they contain valuable debugging information like the stack trace. [default level: error]

description: This rule prohibits trailing semicolons, since they are needless cruft in CoffeeScript. [default level: error]

description: This rule forbids trailing whitespace in your code, since it is needless cruft. [default level: error]

description: This rule prohibits double quotes unless string interpolation is used or the string contains single quotes. [default level: ignore]

description: Disallows defining functions with fat arrows when `this` is not used within the function.  [default level: warn]

description: Requires constructors with parameters to include the parens. [default level: ignore]

description: This rule prohibits `&&`, `||`, `==`, `!=` and `!`. Use `and`, `or`, `is`, `isnt`, and `not` instead. `!!` (for converting to a boolean) is ignored. [default level: ignore]

description: This rule enforces that operators have space around them.  [default level: ignore]

description: This rule checks to make sure you have a space after commas. [default level: ignore]

description: This rule detects when changes are made by transform function, and warns that line numbers are probably incorrect. [default level: warn]

title: JSON schema for coffeelint.json files


chart.json

description: The apiVersion field should be v2 for Helm charts that require at least Helm 3. Charts supporting previous Helm versions have an apiVersion set to v1 and are still installable by Helm 3.

description: The name of the chart

description: A SemVer 2 version

description: The optional kubeVersion field can define semver constraints on supported Kubernetes versions. Helm will validate the version constraints when installing the chart and fail if the cluster runs an unsupported Kubernetes version.

description: A single-sentence description of this project

description: The type of the chart

default: application

enum: application library

description: A list of keywords about this project

description: The URL of this projects home page

format: uri

description: A list of URLs to source code for this project

description:
In Helm, one chart may depend on any number of other charts. These dependencies can be dynamically linked using the dependencies field in Chart.yaml or brought in to the charts/ directory and managed manually.
The charts required by the current chart are defined as a list in the dependencies field.

description: The name of the chart

description: The version of the chart

description: The repository URL or alias

description: A yaml path that resolves to a boolean, used for enabling/disabling charts

description: Tags can be used to group charts for enabling/disabling together

description: ImportValues holds the mapping of source values to parent key to be imported. Each item can be a string or pair of child/parent sublist items.

required: parent child

description: The destination path in the parent chart's values

description: The source key of the values to be imported

description: Alias to be used for the chart. Useful when you have to add the same chart multiple times

description: The maintainers name

description: The maintainers email

format: email

description: A URL for the maintainer

description: A URL to an SVG or PNG image to be used as an icon

description: Note that the appVersion field is not related to the version field. It is a way of specifying the version of the application. For example, the drupal chart may have an appVersion: "8.2.1", indicating that the version of Drupal included in the chart (by default) is 8.2.1. This field is informational, and has no impact on chart version calculations. Wrapping the version in quotes is highly recommended. It forces the YAML parser to treat the version number as a string. Leaving it unquoted can lead to parsing issues in some cases. For example, YAML interprets 1.0 as a floating point value, and a git commit SHA like 1234e10 as scientific notation.

description: When managing charts in a Chart Repository, it is sometimes necessary to deprecate a chart. The optional deprecated field in Chart.yaml can be used to mark a chart as deprecated. If the latest version of a chart in the repository is marked as deprecated, then the chart as a whole is considered to be deprecated. The chart name can be later reused by publishing a newer version that is not marked as deprecated.

description: A list of annotations keyed by name

description:
This annotation is used to provide some details about the changes introduced by a given chart version. Artifact Hub can generate and display a ChangeLog based on the entries in the changes field in all your chart versions.
This annotation can be provided using two different formats: using a plain list of strings with the description of the change or using a list of objects with some extra structured information (see example below). Please feel free to use the one that better suits your needs. The UI experience will be slightly different depending on the choice. When using the list of objects option the valid supported kinds are added, changed, deprecated, removed, fixed and security.

description: Use this annotation to indicate that this chart version contains security updates. When a package release contains security updates, a special message will be displayed in the Artifact Hub UI as well as in the new release email notification.

enum: true false

description:
By default, Artifact Hub will try to extract the containers images used by Helm charts from the manifests generated from a dry-run install using the default values. If you prefer, you can also provide a list of containers images manually by using this annotation.
Containers images will be scanned for security vulnerabilities. The security report generated will be available in the package detail view. It is possible to whitelist images so that they are not scanned by setting the whitelisted flag to true.

description: This annotation can be used to list the operator's CRDs. They will be visible in the package's detail view as cards.

description: Use this annotation to provide a list of example CRs for the operator's CRDs. Each of the examples can be opened from the corresponding CRD card in the package's detail view.

description: Use this annotation to indicate the chart's license. By default, Artifact Hub tries to read the chart's license from the LICENSE file in the chart, but it's possible to override or provide it with this annotation. It must be a valid SPDX identifier.

description: This annotation allows including named links, which will be rendered nicely in Artifact Hub. You can use this annotation to include links not included previously in the Chart.yaml file, or you can use it to name links already present (in the sources section, for example).

description: This annotation can be used if you want to display a different name for a given user in Artifact Hub than the one used in the Chart.yaml file. If the email used matches, the name used in the annotations entry will be displayed in Artifact Hub. It's also possible to include maintainers that should only be listed in Artifact Hub by adding additional entries.

description: Use this annotation to indicate that your chart represents an operator. Artifact Hub at the moment also considers your chart to represent an operator if the word operator appears in the chart name.

description: Use this annotation to indicate the capabilities of the operator your chart provides. It must be one of the following options: Basic Install, Seamless Upgrades, Full Lifecycle, Deep Insights or Auto Pilot. For more information please see the capability level diagram.

enum:
Basic Install
Seamless Upgrades
Full Lifecycle
Deep Insights
Auto Pilot

description: Use this annotation to indicate that this chart version is a pre-release. This status will be displayed in the UI's package view, as well as in new releases notifications emails.

description: This annotation allows recommending other related packages. Recommended packages will be featured in the package detail view in Artifact Hub.

description: This annotation can be used to provide some information about the key used to sign a given chart version. This information will be displayed on the Artifact Hub UI, making it easier for users to get the information they need to verify the integrity and origin of your chart. The url field indicates where users can find the public key and it is mandatory when a sign key entry is provided.

required: apiVersion name version

title: Helm Chart.yaml


jscpd.json

enum: green blue red yellow orange purple pink grey gray cyan black

$ref: #/definitions/colorPreset

$ref: #/definitions/colorHex

enum: abap actionscript ada apacheconf apl applescript arduino arff asciidoc asm6502 aspnet autohotkey autoit bash basic batch bison brainfuck bro c c-header clike clojure coffeescript comments cpp cpp-header crystal csharp csp css-extras css d dart diff django docker eiffel elixir elm erb erlang flow fortran fsharp gedcom gherkin git glsl go graphql groovy haml handlebars haskell haxe hpkp hsts http ichigojam icon inform7 ini io j java javascript jolie json jsx julia keymap kotlin latex less liquid lisp livescript lolcode lua makefile markdown markup matlab mel mizar monkey n4js nasm nginx nim nix nsis objectivec ocaml opencl oz parigp pascal perl php plsql powershell processing prolog properties protobuf pug puppet pure python q qore r reason renpy rest rip roboconf ruby rust sas sass scala scheme scss smalltalk smarty soy sql stylus swift tap tcl textile tsx tt2 twig typescript vbnet velocity verilog vhdl vim visual-basic wasm url wiki xeora xojo xquery yaml

description: minimum size of code block in lines to check for duplication

description: maximum size of source file in lines to check for duplication

description: maximum size of source file in bytes to check for duplication (e.g.,: 1kb, 1mb, 120kb)

description: minimum size of code block in tokens to check for duplication

description: maximum allowed duplicate lines expressed as a percentage; exit with error and exit code 1 when threshold exceeded

description: custom mapping from formats to file extensions (default: https://github.com/kucherenko/jscpd/blob/master/packages/tokenizer/src/formats.ts); see https://github.com/kucherenko/jscpd/blob/master/supported_formats.md

description: path to directory for non-console reports

description: paths that should be included in duplicate detection (default: [process.cwd()])

description: glob pattern for files that should be included in duplicate detection (e.g., **/*.txt); only used to filter directories configured via path option

description: ignore code blocks matching these regular expressions

enum: mild strict weak

default: mild

description: mode of detection quality; see https://github.com/kucherenko/jscpd/blob/master/packages/jscpd/README.md#mode

description: glob pattern for files that should be excluded from duplicate detection

$ref: #/definitions/format

description: list of formats for which to detect duplication (default: all); see https://github.com/kucherenko/jscpd/blob/master/supported_formats.md

enum: leveldb redis

description: store used to collect information about code (default: in-memory store); install @jscpd/leveldb-store and use leveldb for big repositories

enum: xml json csv markdown consoleFull html console silent threshold xcode

description: a list of reporters to use to output information about duplication; see https://github.com/kucherenko/jscpd/blob/master/packages/jscpd/README.md#reporters

description: get information about authors and dates of duplicated blocks from Git

description: do not write duplicate detection progress and result to console

description: show full information during duplicate detection

description: use absolute paths in reports

description: do not follow symlinks

description: skip duplicates within folders; just detect cross-folder duplicates

description: ignore case of symbols in code (experimental)

description: ignore all files from .gitignore file

description: output path for duplication level badge (default: path.join(output, 'jscpd-badge.svg'))

default: Copy/Paste

description: badge subject text (URL-encoding needed for spaces or special characters)

$ref: #/definitions/color

description: badge label color (name or RGB code without #); see https://github.com/badgen/badgen/blob/master/src/color-presets.ts

description: badge value text (URL-encoding needed for spaces or special characters, default: duplication %)

description: badge color (name or RGB code without #, default: green if beneath threshold, red if above threshold, grey if threshold not set); see https://github.com/badgen/badgen/blob/master/src/color-presets.ts

enum: flat classic

default: classic

description: badge look: flat or classic

description: URL for icon to display in front of badge subject text (e.g., data:image/svg+xml;base64,...)

description: SVG width of icon to display in front of badge subject text; set this if icon is not square

description: size of badge relative to default of 1

description: exit code to use when at least one duplicate code block is detected but threshold is not exceeded


bigquery-table.json

enum: INT64 INTEGER FLOAT64 FLOAT NUMERIC BIGNUMERIC BOOL BOOLEAN STRING BYTES DATE DATETIME TIME TIMESTAMP STRUCT RECORD GEOGRAPHY

enum: NULLABLE REQUIRED REPEATED

required: name type

enum: STRUCT RECORD

required: fields type name

$ref: #/definitions/field

description: BigQuery lets you specify a table's schema when you load data into a table or when you create an empty table. A table schema is a JSON file.


description: An annotation used to express code flows through a method or other locations that are related to a result.

description: OBSOLETE (use "step" instead): An identifier for the location, unique within the scope of the code flow within which it occurs.

type: integer string

description: The 0-based sequence number of the location in the code flow within which it occurs.

description: A file location to which this annotation refers.

$ref: #/definitions/physicalLocation

description: The fully qualified name of the method or function that is executing.

description: A key used to retrieve the annotation's logicalLocation from the logicalLocations dictionary.

description: The name of the module that contains the code that is executing.

description: The thread identifier of the code that is executing.

description: A message relevant to this annotation.

description: Categorizes the location.

enum: alias assignment branch call callReturn continuation declaration functionEnter functionExit functionReturn usage

description: Classifies state transitions in code locations relevant to a taint analysis.

enum: source sink sanitizer

description: The fully qualified name of the target on which this location operates. For an annotation of kind 'call', for example, the target refers to the fully qualified logical name of the function called from this location.

description: An ordered set of strings that comprise input or return values for the current operation. For an annotation of kind 'call', for example, this property may hold the ordered list of arguments passed to the callee.

description: A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.

description: A key used to retrieve the target's logicalLocation from the logicalLocations dictionary.

description: OBSOLETE (use "importance" instead): True if this location is essential to understanding the code flow in which it occurs.

description: Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is "essential", "important", "unimportant". Default: "important".

enum: important essential unimportant

description: The source code at the specified location.

description: A set of messages relevant to the current annotated code location.

$ref: #/definitions/annotation

description: Key/value pairs that provide additional information about the code location.

description: A set of distinct strings that provide additional information.

description: A message relevant to a code location

description: An array of 'physicalLocation' objects associated with the annotation.

required: message locations

description: A message relevant to the code flow

description: An array of 'annotatedCodeLocation' objects, each of which describes a single location visited by the tool in the course of producing the result.

$ref: #/definitions/annotatedCodeLocation

description: Key/value pairs that provide additional information about the code flow.

description: A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal.

description: A string that describes the exception.

description: The sequence of function calls leading to the exception.

$ref: #/definitions/stack

description: An array of exception objects each of which is considered a cause of this exception.

$ref: #/definitions/exception

description: A change to a single file.

description: A string that represents the location of the file to change as a valid URI.

description: A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'.

description: An array of replacement objects, each of which represents the replacement of a single range of bytes in a single file specified by 'uri'.

$ref: #/definitions/replacement

required: uri replacements

description: A single file. In some cases, this file might be nested within another file.

description: The path to the file within its containing file.

description: Identifies the key of the immediate parent of the file, if this file is nested.

description: The offset in bytes of the file within its containing file.

description: The length of the file in bytes.

description: The MIME type (RFC 2045) of the file.

description: The contents of the file, expressed as a MIME Base64-encoded byte sequence.

description: An array of hash objects, each of which specifies a hashed value for the file, along with the name of the algorithm used to compute the hash.

$ref: #/definitions/hash

description: Key/value pairs that provide additional information about the file.

description: A proposed fix for the problem represented by a result object. A fix specifies a set of file to modify. For each file, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.

description: A string that describes the proposed fix, enabling viewers to present a proposed change to an end user.

description: One or more file changes that comprise a fix for a result.

$ref: #/definitions/fileChange

required: description fileChanges

description: Contains information that can be used to construct a formatted message that describes a result.

description: A string that identifies the message format used to format the message that describes this result. The value of formatId must correspond to one of the names in the set of name/value pairs contained in the 'messageFormats' property of the rule object whose 'id' property matches the 'ruleId' property of this result.

description: An array of strings that will be used, in combination with a message format, to construct a result message.

description: A hash value of some file or collection of files, together with the algorithm used to compute the hash.

description: The hash value of some file or collection of files, computed by the algorithm named in the 'algorithm' property.

description: The name of the algorithm used to compute the hash value specified in the 'value' property.

required: value algorithm

description: The runtime environment of the analysis tool run.

description: The command line used to invoke the tool.

description: The contents of any response files specified on the tool's command line.

description: The date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.

format: date-time

description: The date and time at which the run ended. See "Date/time properties" in the  SARIF spec for the required format.

description: The machine that hosted the analysis tool run.

description: The account that ran the analysis tool.

description: The process id for the analysis tool run.

description: The fully qualified path to the analysis tool.

description: The working directory for the analysis rool run.

description: The environment variables associated with the analysis tool process, expressed as key/value pairs.

description: Key/value pairs that provide additional information about the run.

description: The location where an analysis tool produced a result.

description: Identifies the file that the analysis tool was instructed to scan. This need not be the same as the file where the result actually occurred.

description: Identifies the file where the analysis tool produced the result.

description: The human-readable fully qualified name of the logical location where the analysis tool produced the result. If 'logicalLocationKey' is not specified, this member is can used to retrieve the location logicalLocation from the logicalLocations dictionary, if one exists.

description: A key used to retrieve the location logicalLocation from the logicalLocations dictionary, when the string specified by 'fullyQualifiedLogicalName' is not unique.

description: The machine-readable fully qualified name for the logical location where the analysis tool produced the result, such as the mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.

description: Key/value pairs that provide additional information about the location.

description: A logical location of a construct that produced a result.

description: Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.

description: Identifies the key of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.

description: The type of construct this logicalLocationComponent refers to. Should be one of 'function', 'member', 'module', 'namespace', 'package', 'resource', or 'type', if any of those accurately describe the construct.

description: Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.

description: An identifier for the condition that was encountered.

description: The stable, unique identifier of the rule (if any) to which this notification is relevant. If 'ruleKey' is not specified, this member can be used to retrieve rule metadata from the rules dictionary, if it exists.

description: A key used to retrieve the rule metadata from the rules dictionary that is relevant to the notification.

description: The file and region relevant to this notification.

description: A string that describes the condition that was encountered.

description: A value specifying the severity level of the notification.

description: The thread identifier of the code that generated the notification.

description: The date and time at which the analysis tool generated the notification.

description: The runtime exception, if any, relevant to this notification.

description: Key/value pairs that provide additional information about the notification.

description: A physical location relevant to a result. Specifies a reference to a programming artifact together with a range of bytes or characters within that artifact.

description: The location of the file as a valid URI.

description: The region within the file where the result was detected.

description: A region within a file where a result was detected.

description: The line number of the first character in the region.

description: The column number of the first character in the region.

description: The line number of the last character in the region.

description: The column number of the last character in the region.

description: The zero-based offset from the beginning of the file of the first byte or character in the region.

description: The length of the region in bytes or characters.

description: The replacement of a single range of bytes in a file. Specifies the location within the file where the replacement is to be made, the number of bytes to remove at that location, and a sequence of bytes to insert at that location.

description: A non-negative integer specifying the offset in bytes from the beginning of the file at which bytes are to be removed, inserted or both. An offset of 0 shall denote the first byte in the file.

description: The number of bytes to delete, starting at the byte offset specified by offset, measured from the beginning of the file.

description: The MIME Base64-encoded byte sequence to be inserted at the byte offset specified by the 'offset' property, measured from the beginning of the file.

description: A result produced by an analysis tool.

description: A value specifying the severity level of the result. If this property is not present, its implied value is 'warning'.

description: A string that describes the result. The first sentence of the message only will be displayed when visible space is limited.

description: A 'formattedRuleMessage' object that can be used to construct a formatted message that describes the result. If the 'formattedMessage' property is present on a result, the 'fullMessage' property shall not be present. If the 'fullMessage' property is present on an result, the 'formattedMessage' property shall not be present

description: One or more locations where the result occurred. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location.

description: A source code or other file fragment that illustrates the result.

description: A unique identifier for the result.

description: A string that contributes to the unique identity of the result.

description: An array of 'stack' objects relevant to the result.

description: An array of 'codeFlow' objects relevant to the result.

description: A grouped set of locations and messages, if available, that represent code areas that are related to this result.

description: A flag value indicating one or more suppression conditions.

description: The state of a result relative to a baseline of a previous run.

description: An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.

description: Key/value pairs that provide additional information about the result.

description: Describes an analysis rule.

description: A stable, opaque identifier for the rule.

description: A rule identifier that is understandable to an end user.

description: A concise description of the rule. Should be a single sentence that is understandable when visible space is limited to a single line of text.

description: A string that describes the rule. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.

description: A set of name/value pairs with arbitrary names. The value within each name/value pair shall consist of plain text interspersed with placeholders, which can be used to format a message in combination with an arbitrary number of additional string arguments.

description: A value specifying the default severity level of the result.

description: A URI where the primary documentation for the rule can be found.

description: Key/value pairs that provide additional information about the rule.

description: Describes a single run of an analysis tool, and contains the output of that run.

description: Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.

description: Describes the runtime environment, including parameterization, of the analysis tool run.

description: A dictionary, each of whose keys is a URI and each of whose values is an array of file objects representing the location of a single file scanned during the run.

description: A dictionary, each of whose keys specifies a logical location such as a namespace, type or function.

description: The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) in the event that a log file represents an actual scan.

description: A list of runtime conditions detected by the tool in the course of the analysis.

description: A list of conditions detected by the tool that are relevant to the tool's configuration.

description: A dictionary, each of whose keys is a string and each of whose values is a 'rule' object, that describe all rules associated with an analysis tool or a specific run of an analysis tool.

description: An identifier for the run.

description: A stable identifier for a run, for example, 'nightly Clang analyzer run'. Multiple runs of the same type can have the same stableId.

description: A global identifier that allows the run to be correlated with other artifacts produced by a larger automation process.

description: The 'id' property of a separate (potentially external) SARIF 'run' instance that comprises the baseline that was used to compute result 'baselineState' properties for the run.

description: The hardware architecture for which the run was targeted.

description: A call stack that is relevant to a result.

description: A message relevant to this call stack.

description: An array of stack frames that represent a sequence of calls, rendered in reverse chronological order, that comprise the call stack.

description: Key/value pairs that provide additional information about the stack.

description: A function call within a stack trace.

description: A message relevant to this stack frame.

description: The uri of the source code file to which this stack frame refers.

description: The line of the location to which this stack frame refers.

description: The name of the module that contains the code of this stack frame.

description: The thread identifier of the stack frame.

description: A key used to retrieve the stack frame logicalLocation from the logicalLocations dictionary, when the 'fullyQualifiedLogicalName' is not unique.

description: The address of the method or function that is executing.

description: The offset from the method or function that is executing.

description: The parameters of the call that is executing.

description: Key/value pairs that provide additional information about the stack frame.

description: The analysis tool that was run.

description: The name of the tool.

description: The name of the tool along with its version and any other useful identifying information, such as its locale.

description: The tool version, in whatever format the tool natively provides.

description: The tool version in the format specified by Semantic Versioning 2.0.

description: The binary version of the tool's primary executable file (for operating systems such as Windows that provide that information).

description: A version that uniquely identifies the SARIF logging component that generated this file, if it is versioned separately from the tool.

description: The tool language (expressed as an ISO 649 two-letter lowercase culture code) and region (expressed as an ISO 3166 two-letter uppercase subculture code associated with a country or region).

description: Key/value pairs that provide additional information about the tool.

description: Static Analysis Results Format (SARIF) Version 1.0.0 JSON Schema: a standard format for the output of static analysis and other tools.

description: The URI of the JSON schema corresponding to the version.

description: The SARIF format version of this log file.

description: The set of runs contained in this log file.

title: Static Analysis Results Format (SARIF) Version 1.0.0 JSON Schema


micro.json

description:
Whether to use the same indentation as a previous line
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
A delay between automatic saves
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether attempt to use super user privileges
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to backup all open buffers
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
A directory to store backups
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to show a basename instead of a full path
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
A way to access the system clipboard
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

enum: external terminal internal

default: external

description:
A position to display a column
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
A color scheme
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

enum: atom-dark bubblegum cmc-16 cmc-tc darcula default dracula-tc dukedark-tc dukelight-tc dukeubuntu-tc geany gotham gruvbox gruvbox-tc material-tc monokai-dark monokai one-dark railscast simple solarized solarized-tc sunny-day twilight zenburn

default: default

description:
Whether to highlight a line with a cursor with a different color
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to display diff inticators before lines
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Divider chars for vertical and horizontal splits
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to use inversed color scheme colors for splits
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
An encoding used to open and save files
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to add a missing trailing new line
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to use a fast algorithm to determine whether a file is changed
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
A line ending format
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

enum: unix dos

default: unix

description:
A filetype for the current buffer
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

default: unknown

description:
Whether to highlight all instances of a searched text after a successful search
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to enable an incremental search in `Find` prompt
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to perform case-insensitive searches
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
An indentation character
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to enable a line at the bottom where messages are printed
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether add a whitespace while using autoindent
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to display nano-style key menu at the bottom
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to underline matching braces
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to create missing directories
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to enable mouse support
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to treat characters sent from the terminal in a single chunk as a paste event
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to extract a line number and a column to open files with from file names
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to permanently save backups
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
A file with list of plugin channels
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Plugin repositories
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
A pluging repository
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to forbid buffer editing
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to remove trailing whitespaces
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to display line numbers
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to display relative line numbers
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to save cursor position in files
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to save command history between closing and re-opening editor
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to save undo after closing file
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
A margin at which a view starts scrolling when a cursor approaches an edge of a view
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Line count to scroll for one scroll event
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to add a leading whitespace while pasting multiple lines
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to wrap long lines
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to create a new horizontal split below the current one
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to create a new vertical split right of the current one
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Format string of left-justified part of the statusline
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

default: $(filename) $(modified)($(line),$(col)) $(status.paste)| ft:$(opt:filetype) | $(opt:fileformat) | $(opt:encoding)

description:
Format string of right-justified part of the statusline
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

default: $(bind:ToggleKeyMenu): bindings, $(bind:ToggleHelp): help

description:
Whether to display a status line
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

default: sudo

description:
A super user command
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

examples: sudo doas

description:
Whether to enable a syntax highlighting
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to navigate spaces at the beginning of lines as if they are tabs
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to invert tab character colors
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to reverse tab bar colors
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
A tab size
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to use spaces instead of tabs
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to use primary clipboard to copy selections in the background
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to wrap long lines by words
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

description:
Whether to assume that the current terminal is `xterm`
https://github.com/zyedidia/micro/blob/master/runtime/help/options.md#options

title: A micro editor config schema


schema-catalog.json

description: A list of JSON schema references.

required: name url description

description: A Minimatch glob expression for matching up file names with a schema.

description: An absolute URL to the schema location

description: The name of the schema

description: A description of the schema

description: A set of specific version to schema mappings

description: The schema version of the catalog

description: Link to https://json.schemastore.org/schema-catalog.json

required: schemas version $schema

title: JSON schema for SchemaStore.org catalog files


build-schema.json

description: es6-global generate relative `require` paths instead of relying on NodeJS' module resolution. Default: commonjs.

description: suffix of generated js files, default to [.js]

$ref: #/definitions/module-format

description: Default: false.

$ref: #/definitions/suffix-spec

$ref: #/definitions/module-format-object

description: true to use the package name as namespace, false to not use

description: provide customized namespace name

$ref: #/definitions/package-spec

enum: dce exception termination

description: The types of analysis to activate. `dce` means dead code analysis, `exception` means exception analysis, and `termination` is to check for infinite loops.

description: Paths for any folders you'd like to exclude from analysis. Useful for bindings and similar. Example: `["src/bindings"]`.

description: Any specific paths inside suppressed folders that you want to unsuppress. Example: ["src/bindings/SomeBinding.res"].

description: specify whether transitively dead items should be reported (default: false)

title: jsx-version

description: backward compatible mode, true means on with the default to be version 1 (the default value is subject to change)

title: dependency

$ref: #/definitions/bs-dependency

description: The shell command is running in *dev* time, and you generated could should be checked in, the depedency is tracked properly during dev time,example: `{ "name" : "ocamllex", "command" : "ocamllex.opt $in -o $out"}`

description: Note that we will add the directory path accordingly

title: sourceItem

description: name of the directory

description: if files are empty, the build system will populate it automatically. Useful for initial build

description: Regex to glob the patterns, syntax is documented [here](http://caml.inria.fr/pub/docs/manual-ocaml/libref/Str.html), for better incremental build performance, we'd suggest listing files explicitly

description: Files to be excluded

$ref: #/definitions/build-generator

description: (WIP) Files generated in dev time

description: Selected modules, for example, [Module_a, Module_b]

description: Default: export all modules. It is recommended for library developers to hide some files/interfaces

title: Sub directories

$ref: #/definitions/sources

description: More source directories

description: true means traverse to all subdirs

description: A _unique_ name for each directory to refer as an internal dependency later

description: When true, all subdirs are considered as a whole as dependency

description: Not implemented yet

description: internal dependencies, if unspecified, all existing listed source files are considered potential dependencies

title: Single non-nested directory

$ref: #/definitions/sourceItem

description: A list of source items

description: A single source item

description: Example: `"src"` or `["src", "test"]` or `[{"dir": "src", "subdirs": [...]}]`

enum: native bytecode js

description: The compiler to use for the target

description: Name of the main module used as entry point for this target. 'entry-point' isn't used when this project is built as a dependency.

$ref: #/definitions/targetItems

description: A list of buildable targets

description: path to gentype, path resolution is similar to ReScript

$ref: #/definitions/react-jsx-version

description: Whether to apply the [RescriptReact](https://github.com/rescript-lang/rescript-react)-specific JSX PPX transformation.

description: Whether to apply the specific version of JSX PPX transformation

description: JSX module, currently only support the React.

enum: classic automatic

description: JSX transformation mode

$ref: #/definitions/dependencies

description: Build the given dependencies in JSX V3 compatibility mode.

description: Default: `["-no-alias-deps"]`

enum: reset prefix append

description: (Not implemented yet)

title: ReScript build configuration

description: All paths are required to be in **Unix format** (foo/bar), the build system normalizes them for other platforms internally

description: The semantic version of the ReScript library

description: Package name

$ref: #/definitions/namespace-spec

description: can be true/false or a customized name

description: Source code location

description: a list of directories that bsb will not look into

description: ReScript dependencies of the library, like in package.json. Currently searches in `node_modules`

description: ReScript dev dependencies of the library, like in package.json. Currently searches in `node_modules`

description: Those dependencies are pinned (since version 8.4)

$ref: #/definitions/rule-generator

description: (WIP) Pre defined rules

description: Ignore generators, cut the dependency on generator tools

$ref: #/definitions/jsx-specs

description: Configuration for the JSX transformation.

description: Configuration for the uncurried mode.

$ref: #/definitions/reason-specs

description: ReScript comes with [Reason](http://reasonml.github.io/) by default. Specific configurations here.

description: gentype config, see cristianoc/genType for more details

description: Flags passed to bsc.exe

description: Default: -40+6+7+27+32..39+44+45 [Here](https://caml.inria.fr/pub/docs/manual-ocaml/comp.html#sec270) for the meanings of the warning flags

description: True means warn is error(default)

description: Same as warning number but different set

description: warning numbers and whether to turn it into error or not

description: PPX macros to pass to compiler. The syntax is package_name/binary, for example: `reason/reactjs_jsx_ppx_3.native`. Currenly searches in `node_modules`

description: preprocessors to pass to compiler. The syntax is package_name/binary, for example: `pp/syntax.exe`. Currenly searches in `node_modules`

description: (Experimental) post-processing hook. bsb will invoke `cmd ${file}` whenever a `${file}` is changed

description: ReScript can currently output to [Commonjs](https://en.wikipedia.org/wiki/CommonJS), and [ES6 modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/import)

description: (internal) Used by bsb to build to different targets: native (ocamlopt), bytecode (ocamlc) or JS (bsc)

description: (Experimental) whether to use the OCaml standard library. Default: true

description: Use the external stdlib library instead of the one shipped with the compiler package

description: (Not needed usually) external include directories, which will be applied `-I` to all compilation units

description: Configure reanalyze, a static code analysis tool for ReScript.


pathfinder-policy-yml-schema.json

title: pathfinderPolicy.yml

description: Define the schema for the the Transcend AI Proxy service.

required: routeName enabledPolicies

const: redactEmail

const: log


DEPRECATED and frozen in KrakenD v2.3. Please use the scpeficic schema for the version you use. For instance https://www.krakend.io/schema/v2.4/krakend.json


description: Defines an op

description: Name of the op

description: Description of the op

description: Parameter of an op

title: arrayParam

description: Array parameter of an op

description: If the array is secret

title: arrayConstraints

description: JSON Schema [additionalItems keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.10)

description: JSON Schema [items keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.9)

description: JSON Schema [maxItems keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.10)

description: JSON Schema [minItems keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.11)

description: JSON Schema [uniqueItems keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-01#section-6.13)

title: booleanParam

description: Boolean parameter of an op

description: Default value

title: dirParam

description: Directory parameter of an op

title: markdown

description: Markdown in [v0.28 CommonMark syntax](http://spec.commonmark.org/0.28/) including GFM table extension

description: Default value; an absolute path rooted at dir containing op.yml or, a relative path interpreted from where the op is started

description: If the directory is secret

title: fileParam

description: File parameter of an op

description: If the file is secret

title: numberParam

description: Number parameter of an op

description: If the number is secret

title: numberConstraints

description: JSON Schema [allOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.22)

description: JSON Schema [anyOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.23)

description: JSON Schema [enum keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.20)

title: integer

description: Requires the number be an integer

description: JSON Schema [maximum keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.2)

description: JSON Schema [minimum keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.4)

description: JSON Schema [multipleOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.1)

description: JSON Schema [not keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.25)

description: JSON Schema [oneOf keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.24)

title: objectParam

description: Object parameter of an op

description: If the object is secret

title: objectConstraints

description: JSON Schema [additionalProperties keyword](https://tools.ietf.org/html/draft-handrews-json-schema-validation-00#section-6.5.6)

description: JSON Schema [dependencies keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.19)

description: JSON Schema [maxProperties keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.13)

description: JSON Schema [minProperties keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.14)

description: JSON Schema [properties keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.16)

title: typeConstraints

description: Parameter constraints

description: JSON Schema [description](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-6.1)

description: JSON Schema [title](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-6.1)

description: JSON Schema [type](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.21)

type: array string

description: JSON Schema [writeOnly](https://tools.ietf.org/html/draft-handrews-json-schema-validation-00#section-10.3)

description: JSON Schema [patternProperties keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.17)

description: JSON Schema [required keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.15)

title: socketParam

description: Socket parameter of an op

description: If the socket is secret

title: stringParam

description: String parameter of an op

description: If the string is secret

title: stringConstraints

description: Superset of JSON Schema [format keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7)

title: date-time

description: JSON Schema [date-time format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.1)

title: docker-image-ref

description: A docker image reference as defined by [github.com/docker/distribution/reference](https://github.com/docker/distribution/tree/docker/1.13/reference)

title: email

description: JSON Schema [email format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.2)

title: hostname

description: JSON Schema [hostname format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.3)

title: ipv4

description: JSON Schema [ipv4 format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.4)

title: ipv6

description: JSON Schema [ipv6 format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.5)

title: uri

description: JSON Schema [uri format](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-7.3.6)

title: semver

description: A semantic version as defined by [semver.org](http://semver.org/)

description: JSON Schema [maxLength keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.6)

description: JSON Schema [minLength keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.7)

description: JSON Schema [pattern keyword](https://tools.ietf.org/html/draft-wright-json-schema-validation-00#section-5.8)

format: regex

description: A single node of the [call graph](https://en.wikipedia.org/wiki/Call_graph)

title: containerCall

description: Command run by a container; overrides any set at the image level

description: Expression coercible to string value

description: Directories in the container

description: (will be bound to same path in op)

description: Expression coercible to dir value &/or scope ref to set upon exit

description: (will be bound to in scope ref w/ same name)

description: Expression coercible to string value

description: Reference to a value

description: Environment variables in the container

description: Files in the container

description: (will be bound to same path in op)

description: Expression coercible to file value &/or scope ref to set upon exit

description: Reference to an image

description: Name the container can be referenced by from other containers

type: array boolean number object string

description: Ports bound from the container to the host

description: Host port(s) to bind to

type: string number

description: Container socket address mapped to a socket ref

description: Working directory path (overrides any defined by image)

description: If any predicate evaluates to false, the call will be skipped.

description: Condition which evaluates to true or false

description: True if all items are equal

description: Expression coercible to string value

description: True if value exists w/ reference

description: True if any items aren't equal

description: Expression coercible to string value

description: True if no value exists w/ reference

description: Initializes INPUT_NAME from VALUE in format 'INPUT_NAME: VALUE'. If VALUE is null, it MUST be assumed VALUE == $(INPUT_NAME)

description: Expression which evaluates to a value

description: Initializes NAME from OUTPUT_NAME in format 'NAME: OUTPUT_NAME'. If OUTPUT_NAME is null, it MUST be assumed NAME == OUTPUT_NAME

description: Credentials used during authentication with the source of an image or op

description: Expression coercible to string value

description: Expression coercible to string value

required: username password

description: Reference to an op

title: parallelCall

description: Loop in which all iterations are called simultaneously.

description: What gets run on each iteration of the loop

title: serialCall

description: Loop in which each iteration gets called sequentially.

description: Range of the loop, i.e. the value to loop over

description: What gets run on each iteration of the loop

description: Exit condition of the loop; evaluated before each iteration.

description: Variables added to scope on each iteration

description: Variable each iterations associated index will be made available through

description: Variable each iterations associated key will be made available through

description: Variable each iterations associated value will be made available through

title: call

description: Version of the op

description: Version of [opspec](https://opspec.io) used by the op

title: semVer

title: Op File


enum: SCHEMA_TYPE_UNSPECIFIED 0 AVRO 1 JSONSCHEMA 2

markdownEnumDescriptions:
(or 0)
(or "SCHEMA_TYPE_UNSPECIFIED")
(or 1)
(or "AVRO")
(or 2)
(or "JSONSCHEMA")

enum: STATE_UNSPECIFIED 0 DRAFT 1 ACTIVE 2 ARCHIVED 3 IN_REVIEW 4 INCOMPLETE 5 APPROVED 6

markdownEnumDescriptions: (or 1) This schema is valid and complete, but has not been accepted yet, can still be modified and also deleted.

markdownEnumDescriptions: (or "DRAFT") This schema is valid and complete, but has not been accepted yet, can still be modified and also deleted.

markdownEnumDescriptions: (or 2) This schema is valid and complete can be used for events and batch jobs. It cannot be modified or deleted.

markdownEnumDescriptions: (or "ACTIVE") This schema is valid and complete can be used for events and batch jobs. It cannot be modified or deleted.

markdownEnumDescriptions: (or 3) This schema is valid and complete has been active, but no more events can be sent using this schema. In-flight events are still processed.

markdownEnumDescriptions: (or "ARCHIVED") This schema is valid and complete has been active, but no more events can be sent using this schema. In-flight events are still processed.

markdownEnumDescriptions: (or 4) This schema is in review. It can be used once it has been approved.

markdownEnumDescriptions: (or "IN_REVIEW") This schema is in review. It can be used once it has been approved.

markdownEnumDescriptions: (or 5) This schema is still under construction.

markdownEnumDescriptions: (or "INCOMPLETE") This schema is still under construction.

markdownEnumDescriptions: (or 6) This schema is approved and when activated can be used used for events and batch jobs. It cannot be modified or deleted.

markdownEnumDescriptions: (or "APPROVED") This schema is approved and when activated can be used used for events and batch jobs. It cannot be modified or deleted.

enum: STATE_UNSPECIFIED 0 DRAFT 1 IN_REVIEW 2 ACTIVE 3 ARCHIVED 4 INCOMPLETE 5 APPROVED 6

markdownEnumDescriptions: (or 1) This data contract is valid and complete, but has not been accepted yet, can still be modified and also deleted.

markdownEnumDescriptions: (or "DRAFT") This data contract is valid and complete, but has not been accepted yet, can still be modified and also deleted.

markdownEnumDescriptions: (or 2) This data contract is in review. It can be used once it has been approved.

markdownEnumDescriptions: (or "IN_REVIEW") This data contract is in review. It can be used once it has been approved.

markdownEnumDescriptions: (or 3) This data contract is valid and complete can be used for events and batch jobs. It cannot be modified or deleted.

markdownEnumDescriptions: (or "ACTIVE") This data contract is valid and complete can be used for events and batch jobs. It cannot be modified or deleted.

markdownEnumDescriptions: (or 4) This data contract is valid and complete has been active, but no more events can be sent using this data contract. In-flight events are still processed.

markdownEnumDescriptions: (or "ARCHIVED") This data contract is valid and complete has been active, but no more events can be sent using this data contract. In-flight events are still processed.

markdownEnumDescriptions: (or 5) This data contract is still under construction.

markdownEnumDescriptions: (or "INCOMPLETE") This data contract is still under construction.

markdownEnumDescriptions: (or 6) This data contract is approved and when activated can be used used for events and batch jobs. It cannot be modified or deleted.

markdownEnumDescriptions: (or "APPROVED") This data contract is approved and when activated can be used used for events and batch jobs. It cannot be modified or deleted.

title: Unknown field

title: string field = 1;

description: constraint: valid field path, follows avro constraints + slashes

title: string type = 2;

description:
constraint: one of the validator types. handled by code
This should become an enum

title: string value = 3;

description: constraint: a type specific definition

markdownEnumDescriptions:
(or 0)
(or "NULL_HANDLING_TYPE_UNSPECIFIED")
(or 1)
(or "DROP_RECORD")
(or 2)
(or "DEFAULT_VALUE")

title: Unknown field

title: google.protobuf.Timestamp create_time = 3;

description: The timestamp when this Schema was created.

title: string description = 2;

description: The description of this Schema. Used in the Portal. Markdown syntax is supported. This field can be modified.

title: string

title: repeated string domains = 6;

title: string icon_uri = 4;

description: The URI to the icon used with this Schema. This always an absolute URI, with the https scheme. Used in the Portal.

title: string

title: repeated string industries = 7;

title: strmprivacy.api.entities.v1.Label

title: repeated strmprivacy.api.entities.v1.Label labels = 5;

description: Generic (key/value) labels for this Schema.

title: string title = 1;

description: The human readable title of this Schema. Used in the Portal. Defaults to the Schema name. This field can be modified.

title: Unknown field

description: The timestamp when this Data Contract was created.

title: string description = 2;

description: The description of this Data Contract. Used in the Portal. Markdown syntax is supported. This field can be modified.

title: string

title: repeated string domains = 6;

title: string

title: repeated string industries = 7;

title: strmprivacy.api.entities.v1.Label

description: Generic (key/value) labels for this Data Contract.

title: string title = 1;

description: The human readable title of this Data Contract. Used in the Portal. Defaults to the Data Contract name if left unspecified. This field can be modified.

title: Unknown field

title: string field_name = 1;

description: Full reference to a (nested) field. For non-top-level fields (i.e. nested fields), each level should be separated by a forward slash. E.g. customer/id.

title: strmprivacy.api.entities.v1.FieldMetadata.NullHandlingConfig null_handling_config = 5;

description: How null values should generally be dealt with for a field.

title: string

title: repeated string ordinal_values = 4;

description: If a field is of ordinal values, defines the possible values and their order.

title: strmprivacy.api.entities.v1.FieldMetadata.PersonalDataConfig personal_data_config = 2;

description: Metadata on the type of personal data this field may contain.

title: strmprivacy.api.entities.v1.StatisticalDataType statistical_data_type = 3;

description: The statistical data type of the field, e.g. nominal, ordinal, numerical.

title: Unknown field

title: string default_value = 2;

description: If the type is DEFAULT_VALUE, the desired default value must be specified.

title: strmprivacy.api.entities.v1.FieldMetadata.NullHandlingConfig.NullHandlingType type = 1;

title: Unknown field

title: string avro_name = 7;

description: avro compatible name set by creator OR derived from name

title: string doc = 6;

description:
constraints:
size < 5000

title: string name = 2;

description: constraints: same as SimpleSchemaDefinition

title: strmprivacy.api.entities.v1.SimpleSchemaNode

title: repeated strmprivacy.api.entities.v1.SimpleSchemaNode nodes = 5;

title: bool repeated = 3;

title: bool required = 4;

title: strmprivacy.api.entities.v1.SimpleSchemaNodeType type = 1;

title: Unknown field

title: string definition = 4;

description: constraints: is no longer required provided simple_schema is not empty.

title: string fingerprint = 5;

title: string id = 8;

description: The UUID of this schema

title: bool is_public = 3;

description: (-- 'is' is intentional here (see https://google.aip.dev/140#booleans) --)

title: strmprivacy.api.entities.v1.SchemaMetadata metadata = 6;

title: strmprivacy.api.entities.v1.SchemaRef ref = 1;

title: strmprivacy.api.entities.v1.Schema.SimpleSchemaDefinition simple_schema = 7;

title: strmprivacy.api.entities.v1.Schema.State state = 2;

title: Unknown field

title: string handle = 1;

description: constraints: generic name constraint

title: string name = 2;

description: constraints: generic name constraint

title: strmprivacy.api.entities.v1.SchemaType schema_type = 4;

title: string version = 3;

description: constraints: `\d+\.\d+\.\d+

title: Unknown field

title: string handle = 1;

description: constraint: handle should already exist

title: string name = 2;

description: constraints: generic name constraint, unique within handle

title: string version = 3;

description: constraints: semantic version, e.g. 1.12.3

title: Unknown field

title: string gdpr_special_personal_data_type = 4;

description: The special sensitive data type as defined by the GDPR https://eur-lex.europa.eu/legal-content/EN/TXT/HTML/?uri=CELEX:32016R0679#d1e2051-1-1

title: bool is_pii = 1;

description: Currently, only string fields or repeated string fields can be marked as PII, since other data types cannot store an encrypted string.

title: bool is_quasi_id = 2;

description: A quasi identifier doesn't identify an individual directly, but combined with other QIs can result in a unique (direct) identifier.

title: int32 purpose_level = 3;

description: The purpose level as defined in the purpose level mapping of an organization.

enum: STATISTICAL_DATA_TYPE_UNSPECIFIED 0 NOMINAL 1 ORDINAL 2 NUMERICAL 3

title: Unknown field

title: bool is_public = 4;

title: string project_id = 11;

title: strmprivacy.api.entities.v1.DataContract.State state = 3;

title: strmprivacy.api.entities.v1.DataContractRef ref = 2;

title: strmprivacy.api.entities.v1.Schema schema = 9;

title: strmprivacy.api.entities.v1.FieldMetadata

title: repeated strmprivacy.api.entities.v1.FieldMetadata field_metadata = 12;

title: string creator_external_user_id = 13;

title: string id = 1;

title: strmprivacy.api.entities.v1.DataContractMetadata metadata = 8;

title: string data_subject_field = 10;

title: int32

title: map<string, int32> pii_fields = 6;

description:
PII Fields as a map, where the key is the field path (i.e. producerSessionId or customer/id) and the
 value is the purpose level, provided as an integer

deprecationMessage: Field "pii_fields" is marked as deprecated

title: strmprivacy.api.entities.v1.Validation

title: repeated strmprivacy.api.entities.v1.Validation validations = 7;

title: string key_field = 5;

title: Unknown field

title: string avro_name = 5;

description: avro compatible name set by creator OR derived from name (thus ignore_empty = true)

title: string doc = 3;

title: string name = 1;

description: constraints: printable characters

title: string namespace = 2;

description:
constraints:
dot separated sequence of name constraints
must be Avro compatible. When absent becomes <handle>.<name>.v<version>

title: repeated strmprivacy.api.entities.v1.SimpleSchemaNode nodes = 4;

description: constraints: overall size < 100000 TBD

enum: SIMPLE_SCHEMA_NODE_TYPE_UNSPECIFIED 0 STRING 1 BOOLEAN 2 FLOAT 3 INTEGER 4 LONG 5 NODE 10

title: Unknown field

title: string key = 1;

description: The key of the label.

title: string value = 2;

description: The value of the label. An empty string means there is no value.

title: strmprivacy.api.entities.v1.DataContract


description: Sets a list of key:value tags on all spans.