description: The image name this push step should push to. Required with and only used by the push step


description: The image tag this push step should push to. See https://docs.cloudbees.com/docs/cloudbees-codeship/latest/pro-builds-and-configuration/steps#_push_steps for details. Only used by the push step

default: latest

type: string


key: registry

description: The image registry this push step should push to. For Docker Hub, use https://registry-1.docker.io. Required with and only used by the push step


description: The location of a Docker configuration file encrypted by Jet to be used with this step. Optional.


description: The name of a service defined in codeship-services.yml that provides the Docker configuration. Optional.


description: An optional list of steps to run if this step fails.

type: array


description: plagiarize.yaml configuration schema

type: object

type: string integer boolean

required: repo strings


key: repo

description: Configuration for strings, files, and file paths to replace in target file


key: url

description: Git url of project to plagiarize


key: checkout

description: Branch, tag, or commit to checkout from project to be plagiarized


key: strings

description: Strings to find in target project and be replaced with plagiarized project's values


key: vars

description: Variables available to be used for finding and replacing by variable name. For example `$var_name: hello` would replace string '$var_name' with 'hello' in target project


description: Configuration file defining an item modifier for a data pack for Minecraft.

enum: mainhand offhand feet legs chest head

enum: minecraft:constant minecraft:uniform minecraft:binomial minecraft:score

type: number

type: number object

type: integer object

type: string object

enum: fixed context

const: fixed

const: context

type: integer

enum: minecraft:context minecraft:storage

type: boolean

type: string array

enum: white orange magenta light_blue yellow lime pink gray light_gray cyan purple blue brown green red black

type: array object string


key: type

description: The number provider type.


key: then

description: A constant value.


key: value

description: The exact value.


description: A random number following a uniform distribution between two values (inclusive).


key: min

description: The minimum value.


key: max

description: The maximum value.


description: A random number following a binomial distribution.


key: n

description: The amount of trials.


key: p

description: The probability of success on an individual trial.


description: A scoreboard value.


key: target

description: Scoreboard name provider.


description: Resource location.


key: name

description: A UUID or player name.


key: score

description: The scoreboard objective.


key: scale

description: Scale to multiply the score before returning it.


key: function

description: Namespaced ID of the function to apply.


description: Applies a predefined bonus formula.


key: enchantment

description: Enchantment ID used for level calculation.


key: parameters

description: Values required for the formula.


key: extra

description: For formula 'binomial_with_bonus_count', the extra value.


key: probability

description: For formula 'binomial_with_bonus_count', the probability.


key: bonusMultiplier

description: For formula 'uniform_bonus_count', the bonus multiplier.


description: For loot table type 'block', copies a block entity's CustomName tag into the item's display.


description: Copies NBT to the item.


key: type

description: NBT provider type.


description: Same as source above.


description: A resource location specifying the storage ID.


key: ops

description: A list of copy operations.


key: source

description: The NBT path to copy from.


description: The NBT path to copy to, starting from the item's tag tag.


key: op

description: Can be replace to replace any existing contents of the target, append to append to a list, or merge to merge into a compound tag.


key: then

description: Copies state properties from dropped block to the item's BlockStateTag tag.


key: block

description: A block ID. Function fails if the block doesn't match.


key: properties

description: A list of property names to copy.


key: items

description: A block state name to copy.


description: Enchants the item with one randomly-selected enchantment. The level of the enchantment, if applicable, is random.


key: enchantments

description: List of enchantment IDs to choose from.


description: Enchants the item, with the specified enchantment level (roughly equivalent to using an enchantment table at that level).


key: treasure

description: Determines whether treasure enchantments are allowed on this item.


key: levels

description: Specifies the exact enchantment level to use.


description: Converts an empty map into an explorer map leading to a nearby generated structure.


key: destination

description: The type of generated structure to locate. Accepts any of the StructureTypes used by the /locate command (case insensitive).


key: decoration

description: The icon used to mark the destination on the map. Accepts any of the map icon text IDs (case insensitive).


key: zoom

description: The zoom level of the resulting map.


description: The size, in chunks, of the area to search for structures. The area checked is square, not circular.


description: Don't search in chunks that have already been generated.


description: For loot tables of type 'block', removes some items from a stack, if there was an explosion. Each item has a chance of 1/explosion radius to be lost.


description: Smelts the item as it would be in a furnace. Used in combination with the entity_properties condition to cook food from animals on death.


description: Adds required item tags of a player head.


key: entity

description: Specifies an entity to be used for the player head.


description: Limits the count of every item stack.


key: limit

description: Specifies the exact limit to use.


key: min

description: Minimum limit to use.


key: max

description: Max limit to use.


description: Adjusts the stack size based on the level of the Looting enchantment on the killer entity.


key: count

description: Specifies the number of additional items per level of looting.


description: Specifies the maximum amount of items in the stack after the looting calculation. If the value is 0, no limit is applied.


description: Add attribute modifiers to the item.


key: name

description: Name of the modifer.


key: attribute

description: The name of the attribute this modifer is to act upon.


key: amount

description: Specifies the amount of the modifier.


key: id

description: UUID of the modifier following.


key: slot

description: Slots the item must be in for the modifier to take effect.


key: then

description: Sets tags needed for banner patterns.


key: patterns

description: List of patterns.


key: pattern

description: The pattern type.


key: color

description: The color for this pattern.


key: append

description: If true, new patterns will be appended to existing ones.


description: For loot tables of type 'block', sets the contents of a container block item to a list of entries.


key: entries

description: The entries to use as contents.


description: Sets the stack size.


description: Specifies the stack size to set.


key: add

description: If true, change will be relative to the current count.


description: Sets the item's damage value (durability) for tools.


key: damage

description: Specifies the damage fraction to set (1.0 is undamaged, 0.0 is zero durability left).


description: If true, change will be relative to current damage.


description: Sets the item's enchantments.


key: enchantments

description: Enchantments to add.


key: additionalProperties

description: Key name is the enchantment ID.


description: If true, change will be relative to current level.


description: Sets the loot table for a container (chest etc.).


description: Specifies the resource location of the loot table to be used.


key: seed

description: Specifies the loot table seed. If absent or set to 0, a random seed will be used.


description: Adds lore to the item.


key: lore

description: List of JSON text components. Each list entry represents one line of the lore. Advanced components are resolved only if entity successfully targets an entity.


key: entity

description: Specifies the entity to act as the source @s in the JSON text component.


key: replace

description: If true, replaces all existing lines of lore, if false appends the list.


description: Adds display name of the item.


key: name

description: A JSON text component name, allowing color, translations, etc. Advanced components are resolved only if entity successfully targets an entity.


description: Specifies an entity to act as source @s in the JSON text component.


description: Adds NBT data to the item.


key: tag

description: Tag string to add, similar to those used by commands. Note that the first bracket is required and quotation marks need to be escaped using a backslash (\).


description: Sets the status effects for suspicious stew.


key: effects

description: The effects to apply.


key: type

description: The effect ID.


key: duration

description: The duration of the effect.


description: A collection of manifests for .NET products, which is updated with each preview and stable release of the .NET SDK and/or Runtime

enum: sts lts

enum: preview go-live active maintenance eol

format: uri

required: channel-version security latest-release-date latest-release latest-runtime latest-sdk product releases.json release-type support-phase


key: dateYYYYMMDD

description: A date in the format YYYY-MM-DD


key: releaseVersion

description: A SemVer-compatible version string


key: releaseType

description: An enumeration describing the different releaes types of a product


key: supportPhase

description: An enumeration describing the different support phases of a product


key: channel-version

description: The version of the product, e.g '5.0' or '1.1'


key: eol-date

description: The end-of-life (EOL) date for this Product when it is considered to be out of support. The value may be `null` if the EOL date is undetermined, e.g. when a product is still a prerelease.


key: security

description: `true` if the latest release of this product includes a security update, `false` otherwise.


key: latest-release-date

description: The date of the latest release of this product.


key: latest-release

description: The version of the latest release


key: latest-runtime

description: The version of the runtime included in the latest release


key: latest-sdk

description: The version of the SDK included in the latest release.  This is usually the SDK with the highest feature band. A ProductRelease may include multiple SDKs across different feature bands, all of which carry the same runtime version.


key: product

description: The name of the product.


description: The URL pointing to the releases.json file that contains information about all the releases  associated with this Product.


key: release-type

description: The type of Product release indicating whether the release is Standard Term Support (sts) or Long Term Support (lts).


key: support-phase

description: The support phase of the Product.


key: releases-index

description: A collection of all released products


description: Used to configure any part of AnyWork automation.

const: swagger-codegen

required: name actions

required: type sourceUrl id

const: download

required: type ngVersion id downloadId

const: generate

required: type generateId

const: correction

required: type typescriptVersion id generateId

const: build

required: type registryUrl token id

const: publish

required: type targetPath publishId

const: install

required: ctype cversion


key: swagger-codegen

description: swagger-codegen Configuration


key: schemas

description: List of schemas (microservices) to generate it's libraries.


key: name

description: Name of schema. This will be used to generate codes, only `[a-zA-Z]+` is accepted.


key: disable

description: Disables all actions over this schema.


key: actions

description: Determines the actions should be applied over this schema.


key: items

description: Defines a download schema task.


key: type

description: Type of action to apply.


key: sourceUrl

description: Source of `swagger.json` schema to download


key: id

description: A unique specific ID of this download to be referenced (`DOWNLOAD_ID`).


description: Defines a TS code generator task.


description: Type of action to apply.


key: ngVersion

description: Specifies Angular version which codes will be generated for.


description: A unique specific ID of this generation to be referenced (`GENERATE_ID`).


key: downloadId

description: The `DOWNLOAD_ID` of downloaded schema to generate codes based on.


description: Defines a code correction task.


description: Type of action to apply.


description: Defines a TS code builder task.


description: Type of action to apply.


key: typescriptVersion

description: Specifies TypeScript version to install before build.


description: A unique specific ID of this build to be referenced (`BUILD_ID`).


description: Defines a `npm publish` task.


description: Type of action to apply.


key: registryUrl

description: The Url of registry accepting this respository.


key: token

description: Token to use access registry.


description: A unique specific ID of this publish to be referenced (`PUBLISH_ID`).


description: Defines a Api install task.


description: Type of action to apply.


key: publishId

description: The `PUBLISH_ID` to use for this task.


key: targetPath

description: The relative or absolute physical path of directory containing `packages.json` to install specified


key: buildId

description: The `BUILD_ID` to use for this task.


key: generateId

description: The `GENERATE_ID` to use for this task.


description: Determines if this task is disabled.


key: ctype

description: type of configuration, means who will use this configuration.


key: cversion

description: Version of configuration. The reader will parse configuration based on this.


key: extends

description: List of modules or file paths containing a shareable configuration. If multiple shareable configurations are set, they will be imported in the order defined with each configuration option taking precedence over the options defined in a previous shareable configuration


key: branches

description: The branches on which releases should happen.


key: repositoryUrl

description: The git repository URL


key: tagFormat

description: The Git tag format used by semantic-release to identify releases. The tag name is generated with Lodash template and will be compiled with the version variable.

default: v${version}


key: plugins

description: Define the list of plugins to use. Plugins will run in series, in the order defined


key: dryRun

description: The objective of the dry-run mode is to get a preview of the pending release. Dry-run mode skips the following steps: prepare, publish, success and fail. In addition to this it prints the next version and release notes to the console


key: ci

description: Set to false to skip Continuous Integration environment verifications. This allows for making releases from a local machine


key: description

description: A description for the extension. Required if the extension is not a VSIX.


key: displayName

description: A display name for the extension. Required if the extension is not a VSIX.


key: icon

description: An icon for the extension. Required if the extension is not a VSIX. Can be relative to the current json file's directory.


key: installTargets

description: A list of install targets for the extension. At least one is required if the extension is not a VSIX.

required: sku version


key: items

description: An installation target for the extension.


key: sku

description: The SKU name of the installation target.


key: version

description: The version range of the install target that the extension can be installed to.


key: internalName

description: The internal name of the extension. A marketplace extension is identified as 'publisherName'.'internalName'. Cannot contain spaces.


key: language

description: The default language the extension applies to. Must be a CLR locale code or an lcid code.

type: string number


key: tags

description: A list of tags for the extension.


description: A tag for the extension.


description: The version of the extension. Required if the extension is not a VSIX.


key: vsixId

description: The vsix identifier of the extension.


key: assetFiles

description: A list of assets to include in the package sent to the marketplace.

required: pathOnDisk targetPath


key: pathOnDisk

description: A path to the file to include in the package. Can be relative to the current json file's directory.


key: targetPath

description: The path to embed the file in the package. This can be referenced from your overview file via an image link, for example


key: categories

description: A list of categories that the extension applies to.

enum:
ajax
build
coding
connected services
data
database
documentation
extension sdk
framework and libraries
lightswitch
lightswitch controls
lightswitch templates
modelling
office
other
other templates
performance
process templates
programming languages
reporting
scaffolding
security
services
setup and deployment
sharepoint
sharepoint controls
sharepoint templates
silverlight controls
source control
start pages
team development
testing
visual studio extensions
wcf
web
windows forms templates
windows forms controls
workflow
wpf templates
wpf controls
xna


description: A valid category on the marketplace that the extension applies to.


key: overview

description: A path to a markdown file that will be displayed on the extension's page in the marketplace. The path can be relative to the current json file's path.


key: priceCategory

description: The pricing model for the extension.

default: free

enum: free trial paid


key: publisher

description: The publisher of the extension. Must not be a display name of the publisher.


key: private

description: If true, the extension will be uploaded as a private extension.


key: qna

description: If true, the extension will have a Q&A page on the marketplace.


key: repo

description: A URL that points to the GitHub repo for the extension.


description: Static Analysis Results Format (SARIF) Version 2.1.0-rtm.4 JSON Schema: a standard format for the output of static analysis tools.

enum: analysisTarget attachment responseFile resultFile standardStream tracedFile unmodified modified added deleted renamed uncontrolled driver extension translation taxonomy policy referencedOnCommandLine memoryContents directory userSpecifiedConfiguration toolSpecifiedConfiguration debugOutputFile

format: date-time

required: artifactLocation replacements

format: uri-reference

required: configuration descriptor

required: id sourceNodeId targetNodeId

enum: notApplicable pass fail review open informational


key: address

description: A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).


key: absoluteAddress

description: The address expressed as a byte offset from the start of the addressable region.


key: relativeAddress

description: The address expressed as a byte offset from the absolute address of the top-most parent object.


key: length

description: The number of bytes in this range of addresses.


key: kind

description: An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.


key: name

description: A name that is associated with the address, e.g., '.text'.


key: fullyQualifiedName

description: A human-readable fully qualified name that is associated with the address.


key: offsetFromParent

description: The byte offset of this address from the absolute or relative address of the parent object.


key: index

description: The index within run.addresses of the cached object for this address.


key: parentIndex

description: The index within run.addresses of the parent object.


key: properties

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


key: artifact

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


key: description

description: A short description of the artifact.


key: location

description: The location of the artifact.


description: Identifies the index of the immediate parent of the artifact, if this artifact is nested.


key: offset

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


description: The length of the artifact in bytes.


key: roles

description: The role or roles played by the artifact in the analysis.


key: mimeType

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


key: contents

description: The contents of the artifact.


key: encoding

description: Specifies the encoding for an artifact object that refers to a text file.


key: sourceLanguage

description: Specifies the source language for any artifact object that refers to a text file that contains source code.


key: hashes

description: A dictionary, each of whose keys is the name of a hash function and each of whose values is the hashed value of the artifact produced by the specified hash function.


key: lastModifiedTimeUtc

description: The Coordinated Universal Time (UTC) date and time at which the artifact was most recently modified. See "Date/time properties" in the SARIF spec for the required format.


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


key: artifactChange

description: A change to a single artifact.


key: artifactLocation

description: The location of the artifact to change.


key: replacements

description: An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'.


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


key: artifactContent

description: Represents the contents of an artifact.


key: text

description: UTF-8-encoded content from a text artifact.


key: binary

description: MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.


key: rendered

description: An alternate rendered representation of the artifact (e.g., a decompiled representation of a binary region).


key: properties

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


description: Specifies the location of an artifact.


key: uri

description: A string containing a valid relative or absolute URI.


key: uriBaseId

description: A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.


key: index

description: The index within the run artifacts array of the artifact object associated with the artifact location.


key: description

description: A short description of the artifact location.


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


key: attachment

description: An artifact relevant to a result.


description: A message describing the role played by the attachment.


description: The location of the attachment.


key: regions

description: An array of regions of interest within the attachment.


key: rectangles

description: An array of rectangles specifying areas of interest within the image.


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


key: codeFlow

description: A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.


key: message

description: A message relevant to the code flow.


key: threadFlows

description: An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.


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


key: configurationOverride

description: Information about how a specific rule or notification was reconfigured at runtime.


key: configuration

description: Specifies how the rule or notification was configured during the scan.


key: descriptor

description: A reference used to locate the descriptor whose configuration was overridden.


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


key: conversion

description: Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.


key: tool

description: A tool object that describes the converter.


key: invocation

description: An invocation object that describes the invocation of the converter.


key: analysisToolLogFiles

description: The locations of the analysis tool's per-run log files.


key: properties

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


key: edge

description: Represents a directed edge in a graph.


key: id

description: A string that uniquely identifies the edge within its graph.


key: label

description: A short description of the edge.


key: sourceNodeId

description: Identifies the source node (the node at which the edge starts).


key: targetNodeId

description: Identifies the target node (the node at which the edge ends).


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


key: edgeTraversal

description: Represents the traversal of a single edge during a graph traversal.


key: edgeId

description: Identifies the edge being traversed.


key: message

description: A message to display to the user as the edge is traversed.


key: finalState

description: The values of relevant expressions after the edge has been traversed.


key: stepOverEdgeCount

description: The number of edge traversals necessary to return from a nested graph.


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


key: exception

description: Describes a runtime exception encountered during the execution of an analysis tool.


key: kind

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 message that describes the exception.


key: stack

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


key: innerExceptions

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


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


key: externalProperties

description: The top-level element of an external property file.


key: schema

description: The URI of the JSON schema corresponding to the version of the external property file format.


key: version

description: The SARIF format version of this external properties object.


key: guid

description: A stable, unique identifier for this external properties object, in the form of a GUID.


key: runGuid

description: A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.


key: conversion

description: A conversion object that will be merged with a separate run.


key: graphs

description: An array of graph objects that will be merged with a separate run.


key: externalizedProperties

description: Key/value pairs that provide additional information that will be merged with a separate run.


key: artifacts

description: An array of artifact objects that will be merged with a separate run.


key: invocations

description: Describes the invocation of the analysis tool that will be merged with a separate run.


key: logicalLocations

description: An array of logical locations such as namespaces, types or functions that will be merged with a separate run.


key: threadFlowLocations

description: An array of threadFlowLocation objects that will be merged with a separate run.


key: results

description: An array of result objects that will be merged with a separate run.


key: taxonomies

description: Tool taxonomies that will be merged with a separate run.


key: driver

description: The analysis tool object that will be merged with a separate run.


key: extensions

description: Tool extensions that will be merged with a separate run.


key: policies

description: Tool policies that will be merged with a separate run.


key: translations

description: Tool translations that will be merged with a separate run.


key: addresses

description: Addresses that will be merged with a separate run.


key: webRequests

description: Requests that will be merged with a separate run.


key: webResponses

description: Responses that will be merged with a separate run.


key: properties

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


key: externalPropertyFileReference

description: Contains information that enables a SARIF consumer to locate the external property file that contains the value of an externalized property associated with the run.


key: location

description: The location of the external property file.


key: guid

description: A stable, unique identifier for the external property file in the form of a GUID.


key: itemCount

description: A non-negative integer specifying the number of items contained in the external property file.


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


key: externalPropertyFileReferences

description: References to external property files that should be inlined with the content of a root log file.


key: conversion

description: An external property file containing a run.conversion object to be merged with the root log file.


key: graphs

description: An array of external property files containing a run.graphs object to be merged with the root log file.


key: externalizedProperties

description: An external property file containing a run.properties object to be merged with the root log file.


key: artifacts

description: An array of external property files containing run.artifacts arrays to be merged with the root log file.


key: invocations

description: An array of external property files containing run.invocations arrays to be merged with the root log file.


key: logicalLocations

description: An array of external property files containing run.logicalLocations arrays to be merged with the root log file.


key: threadFlowLocations

description: An array of external property files containing run.threadFlowLocations arrays to be merged with the root log file.


key: results

description: An array of external property files containing run.results arrays to be merged with the root log file.


key: taxonomies

description: An array of external property files containing run.taxonomies arrays to be merged with the root log file.


key: addresses

description: An array of external property files containing run.addresses arrays to be merged with the root log file.


key: driver

description: An external property file containing a run.driver object to be merged with the root log file.


key: extensions

description: An array of external property files containing run.extensions arrays to be merged with the root log file.


key: policies

description: An array of external property files containing run.policies arrays to be merged with the root log file.


key: translations

description: An array of external property files containing run.translations arrays to be merged with the root log file.


key: webRequests

description: An array of external property files containing run.requests arrays to be merged with the root log file.


key: webResponses

description: An array of external property files containing run.responses arrays to be merged with the root log file.


key: properties

description: Key/value pairs that provide additional information about the external property files.


key: fix

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


key: description

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


key: artifactChanges

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


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


key: graph

description: A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).


description: A description of the graph.


key: nodes

description: An array of node objects representing the nodes of the graph.


key: edges

description: An array of edge objects representing the edges of the graph.


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


key: graphTraversal

description: Represents a path through a graph.


key: runGraphIndex

description: The index within the run.graphs to be associated with the result.


key: resultGraphIndex

description: The index within the result.graphs to be associated with the result.


description: A description of this graph traversal.


key: initialState

description: Values of relevant expressions at the start of the graph traversal that may change during graph traversal.


key: immutableState

description: Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.


key: edgeTraversals

description: The sequences of edges traversed by this graph traversal.


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


key: invocation

description: The runtime environment of the analysis tool run.


key: commandLine

description: The command line used to invoke the tool.


key: arguments

description: An array of strings, containing in order the command line arguments passed to the tool from the operating system.


key: responseFiles

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


key: startTimeUtc

description: The Coordinated Universal Time (UTC) date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format.


key: endTimeUtc

description: The Coordinated Universal Time (UTC) date and time at which the run ended. See "Date/time properties" in the SARIF spec for the required format.


key: exitCode

description: The process exit code.


key: ruleConfigurationOverrides

description: An array of configurationOverride objects that describe rules related runtime overrides.


key: notificationConfigurationOverrides

description: An array of configurationOverride objects that describe notifications related runtime overrides.


key: toolExecutionNotifications

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


key: toolConfigurationNotifications

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


key: exitCodeDescription

description: The reason for the process exit.


key: exitSignalName

description: The name of the signal that caused the process to exit.


key: exitSignalNumber

description: The numeric value of the signal that caused the process to exit.


key: processStartFailureMessage

description: The reason given by the operating system that the process failed to start.


key: executionSuccessful

description: Specifies whether the tool's execution completed successfully.


key: machine

description: The machine that hosted the analysis tool run.


key: account

description: The account that ran the analysis tool.


key: processId

description: The process id for the analysis tool run.


key: executableLocation

description: An absolute URI specifying the location of the analysis tool's executable.


key: workingDirectory

description: The working directory for the analysis tool run.


key: environmentVariables

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


key: stdin

description: A file containing the standard input stream to the process that was invoked.


key: stdout

description: A file containing the standard output stream from the process that was invoked.


key: stderr

description: A file containing the standard error stream from the process that was invoked.


key: stdoutStderr

description: A file containing the interleaved standard output and standard error stream from the process that was invoked.


key: properties

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


key: location

description: A location within a programming artifact.


key: id

description: Value that distinguishes this location from all other locations within a single result object.


key: physicalLocation

description: Identifies the artifact and region.


key: logicalLocations

description: The logical locations associated with the result.


key: message

description: A message relevant to the location.


key: annotations

description: A set of regions relevant to the location.


key: relationships

description: An array of objects that describe relationships between this location and others.


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


key: locationRelationship

description: Information about the relation of one location to another.


key: target

description: A reference to the related location.


key: kinds

description: A set of distinct strings that categorize the relationship. Well-known kinds include 'includes', 'isIncludedBy' and 'relevant'.


key: description

description: A description of the location relationship.


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


key: logicalLocation

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


key: name

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


key: index

description: The index within the logical locations array.


key: fullyQualifiedName

description: The human-readable fully qualified name of the logical location.


key: decoratedName

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


key: parentIndex

description: Identifies the index 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.


key: kind

description: The type of construct this logical location component refers to. Should be one of 'function', 'member', 'module', 'namespace', 'parameter', 'resource', 'returnType', 'type', 'variable', 'object', 'array', 'property', 'value', 'element', 'text', 'attribute', 'comment', 'declaration', 'dtd' or 'processingInstruction', if any of those accurately describe the construct.


key: properties

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


description: Encapsulates a message intended to be read by the end user.


key: text

description: A plain text message string.


key: markdown

description: A Markdown message string.


key: id

description: The identifier for this message.


key: arguments

description: An array of strings to substitute into the message string.


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


key: multiformatMessageString

description: A message string or message format string rendered in multiple formats.


description: A plain text message string or format string.


description: A Markdown message string or format string.


key: node

description: Represents a node in a graph.


description: A string that uniquely identifies the node within its graph.


key: label

description: A short description of the node.


key: location

description: A code location associated with the node.


key: children

description: Array of child nodes.


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


key: notification

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

default: warning

enum: none note warning error


key: locations

description: The locations relevant to this notification.


key: message

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


key: level

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


key: threadId

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


key: timeUtc

description: The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.


key: exception

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


key: descriptor

description: A reference used to locate the descriptor relevant to this notification.


key: associatedRule

description: A reference used to locate the rule descriptor associated with this notification.


key: properties

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


key: physicalLocation

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.


key: address

description: The address of the location.


key: artifactLocation

description: The location of the artifact.


key: region

description: Specifies a portion of the artifact.


key: contextRegion

description: Specifies a portion of the artifact that encloses the region. Allows a viewer to display additional context around the region.


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


key: propertyBag

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


key: tags

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


key: rectangle

description: An area within an image.


key: top

description: The Y coordinate of the top edge of the rectangle, measured in the image's natural units.


key: left

description: The X coordinate of the left edge of the rectangle, measured in the image's natural units.


key: bottom

description: The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units.


key: right

description: The X coordinate of the right edge of the rectangle, measured in the image's natural units.


key: message

description: A message relevant to the rectangle.


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


description: A region within an artifact where a result was detected.


key: startLine

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


key: startColumn

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


key: endLine

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


key: endColumn

description: The column number of the character following the end of the region.


key: charOffset

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


key: charLength

description: The length of the region in characters.


key: byteOffset

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


key: byteLength

description: The length of the region in bytes.


key: snippet

description: The portion of the artifact contents within the specified region.


description: A message relevant to the region.


key: sourceLanguage

description: Specifies the source language, if any, of the portion of the artifact specified by the region object.


key: properties

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


key: replacement

description: The replacement of a single region of an artifact.


key: deletedRegion

description: The region of the artifact to delete.


key: insertedContent

description: The content to insert at the location specified by the 'deletedRegion' property.


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


key: reportingDescriptor

description: Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.


key: id

description: A stable, opaque identifier for the report.


key: deprecatedIds

description: An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.


key: guid

description: A unique identifier for the reporting descriptor in the form of a GUID.


key: deprecatedGuids

description: An array of unique identifies in the form of a GUID by which this report was known in some previous version of the analysis tool.


key: name

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


key: deprecatedNames

description: An array of readable identifiers by which this report was known in some previous version of the analysis tool.


key: shortDescription

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


key: fullDescription

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


key: messageStrings

description: A set of name/value pairs with arbitrary names. Each value is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.


key: defaultConfiguration

description: Default reporting configuration information.


key: helpUri

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


key: help

description: Provides the primary documentation for the report, useful when there is no online documentation.


key: relationships

description: An array of objects that describe relationships between this reporting descriptor and others.


key: properties

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


key: reportingConfiguration

description: Information about a rule or notification that can be configured at runtime.


key: enabled

description: Specifies whether the report may be produced during the scan.


key: level

description: Specifies the failure level for the report.


key: rank

description: Specifies the relative priority of the report. Used for analysis output only.


key: parameters

description: Contains configuration information specific to a report.


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


key: reportingDescriptorReference

description: Information about how to locate a relevant reporting descriptor.


key: id

description: The id of the descriptor.


key: index

description: The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.


key: guid

description: A guid that uniquely identifies the descriptor.


key: toolComponent

description: A reference used to locate the toolComponent associated with the descriptor.


description: Key/value pairs that provide additional information about the reporting descriptor reference.


key: reportingDescriptorRelationship

description: Information about the relation of one reporting descriptor to another.


key: target

description: A reference to the related reporting descriptor.


key: kinds

description: A set of distinct strings that categorize the relationship. Well-known kinds include 'canPrecede', 'canFollow', 'willPrecede', 'willFollow', 'superset', 'subset', 'equal', 'disjoint', 'relevant', and 'incomparable'.


key: description

description: A description of the reporting descriptor relationship.


key: result

description: A result produced by an analysis tool.

default: fail

enum: new unchanged updated absent


key: ruleId

description: The stable, unique identifier of the rule, if any, to which this notification is relevant. This member can be used to retrieve rule metadata from the rules dictionary, if it exists.


key: ruleIndex

description: The index within the tool component rules array of the rule object associated with this result.


key: rule

description: A reference used to locate the rule descriptor relevant to this result.


key: kind

description: A value that categorizes results by evaluation state.


key: level

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


key: message

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


key: analysisTarget

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


key: locations

description: The set of locations where the result was detected. 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 stable, unique identifier for the result in the form of a GUID.


key: correlationGuid

description: A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.


key: occurrenceCount

description: A positive integer specifying the number of times this logically unique result was observed in this run.


key: partialFingerprints

description: A set of strings that contribute to the stable, unique identity of the result.


key: fingerprints

description: A set of strings each of which individually defines a stable, unique identity for the result.


key: stacks

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


key: codeFlows

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


key: graphs

description: An array of zero or more unique graph objects associated with the result.


key: graphTraversals

description: An array of one or more unique 'graphTraversal' objects.


key: relatedLocations

description: A set of locations relevant to this result.


key: suppressions

description: A set of suppressions relevant to this result.


key: baselineState

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


key: rank

description: A number representing the priority or importance of the result.


key: attachments

description: A set of artifacts relevant to the result.


key: hostedViewerUri

description: An absolute URI at which the result can be viewed.


key: workItemUris

description: The URIs of the work items associated with this result.


key: provenance

description: Information about how and when the result was detected.


key: fixes

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


key: taxa

description: An array of references to taxonomy reporting descriptors that are applicable to the result.


key: webRequest

description: A web request associated with this result.


key: webResponse

description: A web response associated with this result.


key: properties

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


key: resultProvenance

description: Contains information about how and when a result was detected.


key: firstDetectionTimeUtc

description: The Coordinated Universal Time (UTC) date and time at which the result was first detected. See "Date/time properties" in the SARIF spec for the required format.


key: lastDetectionTimeUtc

description: The Coordinated Universal Time (UTC) date and time at which the result was most recently detected. See "Date/time properties" in the SARIF spec for the required format.


key: firstDetectionRunGuid

description: A GUID-valued string equal to the automationDetails.guid property of the run in which the result was first detected.


key: lastDetectionRunGuid

description: A GUID-valued string equal to the automationDetails.guid property of the run in which the result was most recently detected.


key: invocationIndex

description: The index within the run.invocations array of the invocation object which describes the tool invocation that detected the result.


key: conversionSources

description: An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result.


key: run

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

default: en-US


key: tool

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.


key: invocations

description: Describes the invocation of the analysis tool.


key: conversion

description: A conversion object that describes how a converter transformed an analysis tool's native reporting format into the SARIF format.


key: language

description: The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).


key: versionControlProvenance

description: Specifies the revision in version control of the artifacts that were scanned.


key: originalUriBaseIds

description: The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.


key: artifacts

description: An array of artifact objects relevant to the run.


key: logicalLocations

description: An array of logical locations such as namespaces, types or functions.


key: graphs

description: An array of zero or more unique graph objects associated with the run.


key: results

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) if a log file represents an actual scan.


key: automationDetails

description: Automation details that describe this run.


key: runAggregates

description: Automation details that describe the aggregate of runs to which this run belongs.


key: baselineGuid

description: The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.


key: redactionTokens

description: An array of strings used to replace sensitive information in a redaction-aware property.


key: defaultEncoding

description: Specifies the default encoding for any artifact object that refers to a text file.


key: defaultSourceLanguage

description: Specifies the default source language for any artifact object that refers to a text file that contains source code.


key: newlineSequences

description: An ordered list of character sequences that were treated as line breaks when computing region information for the run.


key: columnKind

description: Specifies the unit in which the tool measures columns.


key: externalPropertyFileReferences

description: References to external property files that should be inlined with the content of a root log file.


key: threadFlowLocations

description: An array of threadFlowLocation objects cached at run level.


key: taxonomies

description: An array of toolComponent objects relevant to a taxonomy in which results are categorized.


key: addresses

description: Addresses associated with this run instance, if any.


key: translations

description: The set of available translations of the localized data provided by the tool.


key: policies

description: Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).


key: webRequests

description: An array of request objects cached at run level.


key: webResponses

description: An array of response objects cached at run level.


key: specialLocations

description: A specialLocations object that defines locations of special significance to SARIF consumers.


key: properties

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


key: runAutomationDetails

description: Information that describes a run's identity and role within an engineering system process.


key: description

description: A description of the identity and role played within the engineering system by this object's containing run object.


key: id

description: A hierarchical string that uniquely identifies this object's containing run object.


key: guid

description: A stable, unique identifier for this object's containing run object in the form of a GUID.


key: correlationGuid

description: A stable, unique identifier for the equivalence class of runs to which this object's containing run object belongs in the form of a GUID.


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


description: Defines locations of special significance to SARIF consumers.


key: displayBase

description: Provides a suggestion to SARIF consumers to display file paths relative to the specified location.


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


key: stack

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


key: message

description: A message relevant to this call stack.


key: frames

description: An array of stack frames that represents 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.


key: stackFrame

description: A function call within a stack trace.


key: location

description: The location to which this stack frame refers.


key: module

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


key: threadId

description: The thread identifier of the stack frame.


key: parameters

description: The parameters of the call that is executing.


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


key: suppression

description: A suppression that is relevant to a result.

enum: inSource external

enum: accepted underReview rejected


description: A stable, unique identifier for the suppression in the form of a GUID.


key: kind

description: A string that indicates where the suppression is persisted.


key: state

description: A string that indicates the state of the suppression.


key: justification

description: A string representing the justification for the suppression.


description: Identifies the location associated with the suppression.


key: properties

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


key: threadFlow

description: Describes a sequence of code locations that specify a path through a single thread of execution such as an operating system or fiber.


key: id

description: An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.


description: A message relevant to the thread flow.


key: initialState

description: Values of relevant expressions at the start of the thread flow that may change during thread flow execution.


key: immutableState

description: Values of relevant expressions at the start of the thread flow that remain constant.


key: locations

description: A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.


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


key: threadFlowLocation

description: A location visited by an analysis tool while simulating or monitoring the execution of a program.

enum: important essential unimportant

default: important


key: index

description: The index within the run threadFlowLocations array.


description: The code location.


key: stack

description: The call stack leading to this location.


key: kinds

description: A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.


key: taxa

description: An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.


key: module

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


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.


key: nestingLevel

description: An integer representing a containment hierarchy within the thread flow.


key: executionOrder

description: An integer representing the temporal order in which execution reached this location.


key: executionTimeUtc

description: The Coordinated Universal Time (UTC) date and time at which this location was executed.


key: importance

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


key: webRequest

description: A web request associated with this thread flow location.


key: webResponse

description: A web response associated with this thread flow location.


key: properties

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


key: tool

description: The analysis tool that was run.


key: driver

description: The analysis tool that was run.


key: extensions

description: Tool extensions that contributed to or reconfigured the analysis tool that was run.


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


key: toolComponent

description: A component, such as a plug-in or the driver, of the analysis tool that was run.

default: localizedData nonLocalizedData

enum: localizedData nonLocalizedData


key: guid

description: A unique identifier for the tool component in the form of a GUID.


key: name

description: The name of the tool component.


key: organization

description: The organization or company that produced the tool component.


key: product

description: A product suite to which the tool component belongs.


key: productSuite

description: A localizable string containing the name of the suite of products to which the tool component belongs.


key: shortDescription

description: A brief description of the tool component.


key: fullDescription

description: A comprehensive description of the tool component.


key: fullName

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


key: version

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


key: semanticVersion

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


key: dottedQuadFileVersion

description: The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).


key: releaseDateUtc

description: A string specifying the UTC date (and optionally, the time) of the component's release.


key: downloadUri

description: The absolute URI from which the tool component can be downloaded.


key: informationUri

description: The absolute URI at which information about this version of the tool component can be found.


key: globalMessageStrings

description: A dictionary, each of whose keys is a resource identifier and each of whose values is a multiformatMessageString object, which holds message strings in plain text and (optionally) Markdown format. The strings can include placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments.


key: notifications

description: An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.


key: rules

description: An array of reportingDescriptor objects relevant to the analysis performed by the tool component.


key: taxa

description: An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.


key: locations

description: An array of the artifactLocation objects associated with the tool component.


key: language

description: The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).


key: contents

description: The kinds of data contained in this object.


key: isComprehensive

description: Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.


key: localizedDataSemanticVersion

description: The semantic version of the localized strings defined in this component; maintained by components that provide translations.


description: The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.


key: associatedComponent

description: The component which is strongly associated with this component. For a translation, this refers to the component which has been translated. For an extension, this is the driver that provides the extension's plugin model.


key: translationMetadata

description: Translation metadata, required for a translation, not populated by other component types.


key: supportedTaxonomies

description: An array of toolComponentReference objects to declare the taxonomies supported by the tool component.


key: properties

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


key: toolComponentReference

description: Identifies a particular toolComponent object, either the driver or an extension.


key: name

description: The 'name' property of the referenced toolComponent.


key: index

description: An index into the referenced toolComponent in tool.extensions.


key: guid

description: The 'guid' property of the referenced toolComponent.


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


description: Provides additional metadata related to translation.


description: The name associated with the translation metadata.


key: fullName

description: The full name associated with the translation metadata.


key: shortDescription

description: A brief description of the translation metadata.


key: fullDescription

description: A comprehensive description of the translation metadata.


key: downloadUri

description: The absolute URI from which the translation metadata can be downloaded.


key: informationUri

description: The absolute URI from which information related to the translation metadata can be downloaded.


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


key: versionControlDetails

description: Specifies the information necessary to retrieve a desired revision from a version control system.


key: repositoryUri

description: The absolute URI of the repository.


key: revisionId

description: A string that uniquely and permanently identifies the revision within the repository.


key: branch

description: The name of a branch containing the revision.


key: revisionTag

description: A tag that has been applied to the revision.


key: asOfTimeUtc

description: A Coordinated Universal Time (UTC) date and time that can be used to synchronize an enlistment to the state of the repository at that time.


key: mappedTo

description: The location in the local file system to which the root of the repository was mapped at the time of the analysis.


key: properties

description: Key/value pairs that provide additional information about the version control details.


key: webRequest

description: Describes an HTTP request.


description: The index within the run.webRequests array of the request object associated with this result.


key: protocol

description: The request protocol. Example: 'http'.


key: version

description: The request version. Example: '1.1'.


key: target

description: The target of the request.


key: method

description: The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.


key: headers

description: The request headers.


key: parameters

description: The request parameters.


key: body

description: The body of the request.


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


key: webResponse

description: Describes the response to an HTTP request.


key: index

description: The index within the run.webResponses array of the response object associated with this result.


description: The response protocol. Example: 'http'.


description: The response version. Example: '1.1'.


key: statusCode

description: The response status code. Example: 451.


key: reasonPhrase

description: The response reason. Example: 'Not found'.


description: The response headers.


description: The body of the response.


key: noResponseReceived

description: Specifies whether a response was received from the server.


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


key: $schema

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


description: The SARIF format version of this log file.


key: runs

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


key: inlineExternalProperties

description: References to external property files that share data between runs.


key: properties

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


The AAD client secret credential used to acquire a token for the AAD application that has the required
 permissions on this Blob Storage Container.


description:
(-- api-linter: core::0122::name-suffix=disabled
     aip.dev/not-precedent: We refer to a container name. --)
 Name of the Storage Container


description:
The base URI of the Azure Storage Account. Typically this is 'https://<your-account-name>.blob.core.windows.net',
 but Azure users can map this to their own domain or subdomain.


description:
********************************
Batch Jobs
Currently we only support:
- CSV as DataFormat type
- a clean database for every batch job
- CSV files with a header row, because the header is needed to get the field names
*******************************


key: id

description: the UUIDv4 of the job, generated upon creation


description: the UUIDv4 of the STRM Privacy project


description: refers to a key stream.

deprecationMessage: Field "billing_id" is marked as deprecated


key: name

description: the name of the stream


description: Client ID of the Azure AD Application.


description: Client secret to use for authentication.


description: Tenant ID of the Azure AD Application.


description:
********************************
K-Member Micro-aggregation Batch Job
Currently we only support:
- CSV as DataFormat type
- CSV files with a header row, because the header is needed to get the field names
- Numerical, Categorical & Ordinal data
*******************************


Configuration specifically for the aggregation algorithm.


description: refers to a event stream.


description:
the name of the stream
constraints: generic name


description: If specified, these fields will be used to aggregate on. Otherwise, fields specified as Quasi Identifiers in the data contract are used instead.


description: The desired k-anonymity level.


description: A batch exporter.

deprecationMessage: Field "sink_name" is marked as deprecated


key: interval

description: granularity of seconds, nanos is unused


description:
(-- api-linter: core::0122::name-suffix=disabled
     aip.dev/not-precedent: We refer to the sink by name. --)
 Deprecated in favor of data_connector_ref


key: handle

description: constraint: handle should already exist


description: constraints: generic name constraint, unique within handle


key: version

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


description:
Consent level is meant to interpret the consent-levels of an event for decryption purposes only.

Cumulative means that the highest consent-level in an event must be greater than or equal to the single requested level
for the decrypted stream.

Granular means that the set of consent-levels in an event must enclose the set of requested event levels for the
decrypted stream.

enum: CONSENT_LEVEL_TYPE_UNSPECIFIED 0 CUMULATIVE 1 GRANULAR 2

markdownEnumDescriptions:
(or 0)
(or "CONSENT_LEVEL_TYPE_UNSPECIFIED")
(or 1)
(or "CUMULATIVE")
(or 2)
(or "GRANULAR")


description:
(-- api-linter: core::0122::name-suffix=disabled
     aip.dev/not-precedent: We think file_name is a better name. --)


description: If omitted, files are read from the root of the bucket.


description:
(-- api-linter: core::0122::name-suffix=disabled
     aip.dev/not-precedent: We refer to a bucket name. --)


key: credentials

description:
The Google Cloud Service Account credentials JSON that is used to access the Google Cloud Storage bucket.
 We do not support credentials in P12 format.


description:
this is a private key for a service account to authenticate with google bigquery. It is added by the cli upon
 creating the jdbc data connector


description:
map of event-contract-ref vs field patterns

constraints:
 data-contract-refs should be existing data contracts
 field_patterns should be valid values (checked by events-core)
 the field_patterns list should have no duplicates.


description: Default Murmurhash3 if empty


key: seed

description: hashing seed


key: field

description: generic field name


key: format

description: Java Time Format template, see https://docs.oracle.com/javase/8/docs/api/java/time/format/DateTimeFormatter.html


description:
Represents a time zone from the
 [IANA Time Zone Database](https://www.iana.org/time-zones).


description: IANA Time Zone Database time zone, e.g. "America/New_York".


description: Optional. IANA Time Zone Database version number, e.g. "2019a".


description:
The ARN of the role to assume.
If present, start an AssumeRole flow to get temporary credentials in another AWS account.
This is used when the customer has a separate users account.
Default there is no assumed role.


description:
The AWS IAM credentials that give access to this bucket, in JSON format as returned by the AWS CLI. This means a
 JSON with at least one property: "AccessKey", which contains at least the two properties: "AccessKeyId" and
 "SecretAccessKey".


key: alt-require

description: Alt of img must be present and alt of area[href] and input[type=image] must be set value.


key: attr-lowercase

description: Attribute name must be lowercase.


key: attr-no-duplication

description: The same attribute can't be specified twice.


key: attr-unsafe-chars

description: Attribute value cant not use unsafe chars.


key: attr-value-double-quotes

description: Attribute value must closed by double quotes.


key: attr-value-not-empty

description: Attribute must set value.


key: doctype-first

description: Doctype must be first.


description: Doctype must be html5.


key: head-script-disabled

description: The script tag can not be used in head.


key: href-abs-or-rel

description: Href must be absolute or relative.


key: html-lang-require

description: The lang attribute of an <html> element must be present and should be valid.


key: id-class-ad-disabled

description: Id and class can not use ad keyword, it will blocked by adblock software.


key: id-class-value

description: Id and class value must meet some rules: underline, dash, hump.


key: id-unique

description: ID attributes must be unique in the document.


key: inline-script-disabled

description: Inline script cannot be used.


key: inline-style-disabled

description: Inline style cannot be used.


key: space-tab-mixed-disabled

description: Spaces and tabs can not mixed in front of line.


key: spec-char-escape

description: Special characters must be escaped.


key: src-not-empty

description: Src of img(script,link) must set value. Empty of src will visit current page twice.


key: style-disabled

description: Style tag can not be used.


key: tag-pair

description: Tag must be paired.


key: tag-self-close

description: The empty tag must closed by self.


key: tagname-lowercase

description: Tagname must be lowercase.


key: title-require

description: <title> must be present in <head> tag.


key: conjure-imports

description: A map between a namespace and a relative path to a Conjure definition file.


key: imports

description: A map between a type alias and its external definition. Type aliases MUST be in PascalCase.


key: definitions

description: The types specified in this definition.


key: base-type

description: A base-type is provided as a hint to generators for how to handle this type when no external type reference is provided. Note that the serialization format of the base-type fallback should match the format of the imported type. If the imported type is a non-primitive JSON object, then a base-type of any should be used.


key: external

description: The external types to reference.


key: ExternalImportDefinition

description: References to types that are not defined within Conjure.


key: java

description: The fully qualified Java type.


key: TypeName

description: Named types must be in PascalCase and be unique within a package.


key: ContainerType

description: Container types like optional<T>, list<T>, set<T> and map<K, V> can be referenced using their lowercase names, where variables like T, K and V can be substituted for a Conjure named type, a built-in or more container types:


key: alias

description: The Conjure type to be aliased.


description: Defines configuration to be used with cli

default: recording


key: url

description: Initial URL to start recording from


key: workdir

description: Directory where logs (eg: jtl files) and other relevant data is stored


key: urlIncludes

description:
Regular expressions used to only record requests with matching URLs.
NOTE: Don't include scheme (e.g: http://) in regex


key: urlExcludes

description:
Regular expressions used to NOT record requests with matching URLs.
NOTE: Don't include scheme (e.g: http://) in regex


key: urlIgnoreDefaultFilter

description: Specifies to use or not the default URL filter. The default filter ignores URLs matching: (?i).*\.(bmp|css|js|gif|ico|jpe?g|png|svg|swf|ttf|woff2?|webp)(\?.*)?


key: logFilteredRequests

description: Specifies to include in generated JTL file, filtered and not recorded requests or not.


key: headerExcludes

description: Regular expressions used to ignore matching headers from recording


key: headerIgnoreDefaultFilter

description: Specifies to use or not the default headers filter. The default filter ignores these headers: Accept-Language,Upgrade-Insecure-Requests,Accept-Encoding,User-Agent,Accept,Referer,Origin,X-Requested-With,Cache-Control


key: correlations

description: Specifies list of correlation rules between requests and previous responses, avoiding fixed and brittle recorded test plans


key: variable

description: Name of the variable used to store a value extracted from a response and to be used in a following request


key: extractor

description: Defines regular expression and, optionally, other parameters which define how to extract values from responses (or even requests), to be used in following requests


description: Regular expression where the first capturing group defines the extracted value, while the rest is used for context matching


key: regex


key: target

description:
Specifies sample result property to apply the extractor to.
For details on available options check: https://javadoc.io/static/us.abstracta.jmeter/jmeter-java-dsl/1.8/us/abstracta/jmeter/javadsl/core/postprocessors/DslRegexExtractor.TargetField.html#enum.constant.summary


key: replacement

description: Regular expression used to replace in requests previously extracted values. The first capturing group defines the place where the extracted value should appear (and replaced by variable reference), while the rest of the regex is used for context matching


description:
Specify whether allow blank issue creation
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser


description:
Contact links
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser

required: name url about


key: name

description:
A link title
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser


description:
A link URL
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser


key: about

description:
A link description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser


key: classPrefix

description: A string that is added before each CSS class


key: minify

description: A flag indicating whether to minify the Modernizr source


key: options

description: A list of Modernizr options to include in the build

enum: addTest atRule domPrefixes hasEvent html5shiv html5printshiv load mq prefixed prefixes prefixedCSS setClasses testAllProps testProp testStyles


key: feature-detects

description: A list of the browser features to be detected

enum: a/download ambientlight applicationcache audio audio/loop audio/preload audio/webaudio battery battery/lowbattery blob canvas canvas/blending canvas/todataurl canvas/winding canvastext contenteditable contextmenu cookies cors crypto crypto/getrandomvalues css/all css/animations css/appearance css/backdropfilter css/backgroundblendmode css/backgroundcliptext css/backgroundposition-shorthand css/backgroundposition-xy css/backgroundrepeat css/backgroundsize css/backgroundsizecover css/borderimage css/borderradius css/boxshadow css/boxsizing css/calc css/checked css/chunit css/columns css/cubicbezierrange css/displayrunin css/displaytable css/ellipsis css/escape css/exunit css/filters css/flexbox css/flexboxlegacy css/flexboxtweener css/flexwrap css/fontface css/generatedcontent css/gradients css/hairline css/hsla css/hyphens css/invalid css/lastchild css/mask css/mediaqueries css/multiplebgs css/nthchild css/objectfit css/opacity css/overflow-scrolling css/pointerevents css/positionsticky css/pseudoanimations css/pseudotransitions css/reflections css/regions css/remunit css/resize css/rgba css/scrollbars css/shapes css/siblinggeneral css/subpixelfont css/supports css/target css/textalignlast css/textshadow css/transforms css/transforms3d css/transformstylepreserve3d css/transitions css/userselect css/valid css/vhunit css/vmaxunit css/vminunit css/vwunit css/will-change css/wrapflow custom-protocol-handler customevent dart dataview-api dom/classlist dom/createElement-attrs dom/dataset dom/documentfragment dom/hidden dom/microdata dom/mutationObserver elem/datalist elem/details elem/output elem/picture elem/progress-meter elem/ruby elem/template elem/time elem/track elem/unknown emoji es5/array es5/date es5/function es5/object es5/specification es5/strictmode es5/string es5/syntax es5/undefined es6/array es6/collections es6/contains es6/generators es6/math es6/number es6/object es6/promises es6/string event/deviceorientation-motion event/oninput eventlistener exif-orientation file/api file/filesystem flash forms/capture forms/fileinput forms/fileinputdirectory forms/formattribute forms/inputnumber-l10n forms/placeholder forms/requestautocomplete forms/validation fullscreen-api gamepad geolocation hashchange hiddenscroll history htmlimports ie8compat iframe/sandbox iframe/seamless iframe/srcdoc img/apng img/jpeg2000 img/jpegxr img/sizes img/srcset img/webp img/webp-alpha img/webp-animation img/webp-lossless indexeddb indexeddbblob input input/formaction input/formenctype input/formmethod input/formtarget inputsearchevent inputtypes intl json lists-reversed mathml network/beacon network/connection network/eventsource network/fetch network/xhr-responsetype network/xhr-responsetype-arraybuffer network/xhr-responsetype-blob network/xhr-responsetype-document network/xhr-responsetype-json network/xhr-responsetype-text network/xhr2 notification pagevisibility-api performance pointerevents pointerlock-api postmessage proximity queryselector quota-management-api requestanimationframe script/async script/defer serviceworker speech/speech-recognition speech/speech-synthesis storage/localstorage storage/sessionstorage storage/websqldatabase style/scoped svg svg/asimg svg/clippaths svg/filters svg/foreignobject svg/inline svg/smil templatestrings test/css/scrollsnappoints test/elem/bdi test/img/crossorigin test/ligatures textarea/maxlength touchevents typed-arrays unicode unicode-range url/bloburls url/data-uri url/parser url/urlsearchparams userdata vibration video video/autoplay video/loop video/preload vml web-intents webanimations webgl webgl/extensions webrtc/datachannel webrtc/getusermedia webrtc/peerconnection websockets websockets/binary window/framed workers/blobworkers workers/dataworkers workers/sharedworkers workers/transferables workers/webworkers xdomainrequest


key: pathPattern

description: Regular expression


key: variables

description: The current directory


description: The filename you pass to nodemon

const: {{filename}}


key: colours

description: set to false to disable color output


key: cwd

description: change into <dir> before running the script


key: delay

description: debounce restart for a number of milliseconds


key: dump

description: print full debug configuration


key: exec

description: execute script with "app", ie. -x "python -v".  May use variables.

format: <app> <your args>


key: execMap

description: The global config file is useful for setting up default executables


key: exitcrash

description: Exit nodemon after crash


key: ext

description: extensions to look for, ie. "js,jade,hbs"


key: ignore

description: Ignore directory or file.  One entry per ignored value.  Wildcards are allowed.


key: items

description: Path or pattern of file or directory to ignore.  Can also use regular expressions wrapped in an object with a single property named "re".


key: ignoreRoot

description: root paths to ignore


key: legacyWatch

description: use polling to watch for changes (typically needed when watching over a network/Docker)


key: noUpdateNotifier

description: opt-out of update version check


key: nodeArgs

description: arguments to pass to node if exec is "node"


key: pollingInterval

description: combined with legacyWatch, milliseconds to poll for (default 100)


key: quiet

description: minimise nodemon messages to start/stop only


key: runOnChangeOnly

description: execute script on change only, not startup


key: signal

description: use specified kill signal instead of default (ex. SIGTERM)


key: spawn

description: force nodemon to use spawn (over fork) [node only]


key: stdin

description: set to false to have nodemon pass stdin directly to child process


key: verbose

description: show detail on what is causing restarts


key: watch

description: Watch directory or file.  One entry per watched value.  Wildcards are allowed.


description: Path or pattern of file or directory to watch.  Can also use regular expressions wrapped in an object with a single property named "re".


key: cvars

description: CVar name


key: commands

description: Console command name


key: value

description: The default value of the CVar


description: This indicates where the assets are stored

default: Assets


description: This indicates where the code is stored

default: Code


key: name

description: This indicates the project name


key: engine

description: This indicates which engine version will be used


key: path

description: Required plugin's name

examples: CryDefaultEntities CrySensorSystem CryPerceptionSystem CryUserAnalytics CryOSVR CryOculusVR CryOpenVR CryLobby


key: type

description: EPluginType::Native if it's a C++ plugin, EPluginType::Managed if it's a C# one


description: Arguments that has to be passed to the command. Leave empty if it has not parameters


Super-schema that describes all versions of 'Resource import JSON Schema.'


Schema that describes the structure of a resource import document.


description: A damage type's for a Minecraft data pack config schema

enum: hurt thorns drowning burning poking freezing

required: message_id scaling exhaustion


description: An Apple Universal Link config schema

required: apps details


key: applinks

description: Application links


key: apps

description: Applications


key: details

description: Details


key: items

description: A detail


key: appID

description: An appID key or app ID prefix, followed by the bundle ID


key: paths

description: Paths


description: Path to open in the mobile app


key: drupal

required: breakpointsPath themeName


key: css


key: options


key: pageObject

description: An object representing a page or a UI element in a web page

enum: web native

default: web

enum: document root navigation


key: implements

description: reference to the interface implemented by the page object


key: profile

description: list of profiles that can use this page object implementation.


key: platform

description: Declares the page context type (WebView or native).


key: beforeLoad

description: The beforeLoad array sets the criteria to be satisfied before the load method completes. If you don't specify a beforeLoad array, the load method finds a root element for a regular page object, or waits for the root element to be present for a root page object), by default.


key: methods

description: An array of methods performing actions on this page object's elements.


key: shadow

description: A shadow boundary at the root of the page object.


key: pageObjectInterface

description: An interace to abstract page object APIs for page objects with similar structure and function.


key: interface

description: Indicates that this page object describes an interface.


description: An array of method declarations that page objects implementing this interface must define.


key: element

enum: actionable clickable editable draggable touchable


key: elementsArray

description: A nested tree of element objects.


key: selector

description: An object that locates an element or a list of elements at run time.


key: args

description: Parameters to the methods that access this element or its nested elements.


key: returnAll

description: Returns a list of elements


description: Standard CSS selector.


key: accessid

description: Accessibility ID selector, a unique identifier for a UI element for Mobile Platform only.


key: classchain

description: Class chain selector, a unique identifier for a window element from the root of the page for iOS platform only.


key: uiautomator

description: A UIAutomator selector to enable search through UiSelectors for Android platform only


key: type

description: URI-like type value of the page object


key: findFirst

description: Return only the first match result.


key: interfaceMethod

description: A declarative, interface method definition.


key: composeMethod

description: A method definition, composed of element actions.

required: name compose


key: action

description: An action to be performed on an element.

default: void

required: type invoke


description: element reference can have nested literal args (hardcoded values for its getter)


key: rootDescription

description: summary of the functionality and use cases

type: object string


key: metadata

description: track miscellaneous information for the page object


key: methodDescription

description: summary at the method or element level


enum: slider textbox dropdown folderDropdown button label color checkbox

const: slider

required: text max min step

const: textbox

const: dropdown

required: text items

const: folderDropdown

required: text filter folder

const: button

const: label

const: color

const: checkbox

required: type value


key: additionalProperties


key: value

description: The default slider value.


key: text

description: The slider title.


key: max

description: The maximum slider value.


key: min

description: The minimum slider value.


key: step

description: The precision used when selecting a value with the slider.


description: The default text box text.


description: The text box title.


description: The default item index, starting at 0.


description: The dropdown title.


key: items

description: An array of labels for the dropdown.


description: The default file.


key: filter

description: Defines a filter of files to include (e.g. "*.jpg|*.png").


key: folder

description: The default folder. Only works for directory within parent html file.


description: The button label.


description: The button title.


description: The label text.


description: The default hex color string (e.g. "#C0C0C0").


description: The color picker title.


description: The check box title.


description: The default check box state.


key: id

description: Unique id of this pattern


key: name

description: Machine readable name of the pattern


key: displayName

description: Human readable name of the pattern


key: version

description: Semantic version of the pattern


key: versions

description: Available semantic versions of the pattern


description: Semantic version of the pattern


key: flag

description: Stability flag of the pattern

pattern: ^alpha|beta|rc|stable$


key: tags

description: Array of tags describing the pattern


description: Tag describing the pattern


key: data

description: Custom data object supplied by user


key: meta

description: Custom meta data object supplied by user


key: options

description: Custom options object supplied by user


key: patterns

description: Dependencies of the pattern


key: demoPatterns

description: Dependencies of the pattern used for demo purposes


key: overrides

description: Options for overriding of core pattern behaviour


key: files

description: Custom mapping between patternplate files and paths to use in exchange for this pattern


key: demo

description: Custom url to use as demo for this pattern


description: Technical values saved by patternplate core


description: Ansible Inventory Schema


default: Front

enum: Front Back

default: SameLineWhere

default: Auto

enum: Always Never Auto

default: AlwaysSameLine

default: Files

enum: Files Stdout Coverage Checkstyle Json ModifiedLines Diff

default: Tall

enum: Compressed Tall Vertical

default: Preserve

enum: Preserve StdExternalCrate One

enum: Preserve Upper Lower

enum: Preserve Crate Module Item One

default: Block

enum: Visual Block

default: Mixed

enum: Vertical Horizontal HorizontalVertical LimitedHorizontalVertical Mixed

default: Never

enum: Always Never Preserve

enum: Auto Windows Unix Native

enum: Always Unnumbered Never

default: Vertical

enum: Always Never Vertical


description:
Maximum width of an array literal before falling back to vertical formatting.

[Documentation](https://rust-lang.github.io/rustfmt/#array_width)


description:
Maximum width of the args of a function-like attributes before falling back to vertical formatting.

[Documentation](https://rust-lang.github.io/rustfmt/#attr_fn_like_width)


description:
Where to put a binary operator when a binary expression goes multiline

[Documentation](https://rust-lang.github.io/rustfmt/#binop_separator)

### Unstable
This option requires Nightly Rust.


description:
Minimum number of blank lines which must be put between items

[Documentation](https://rust-lang.github.io/rustfmt/#blank_lines_lower_bound)

### Unstable
This option requires Nightly Rust.


description:
Maximum number of blank lines which can be put between items

[Documentation](https://rust-lang.github.io/rustfmt/#blank_lines_upper_bound)

### Unstable
This option requires Nightly Rust.


description:
Brace style for items

[Documentation](https://rust-lang.github.io/rustfmt/#brace_style)

### Unstable
This option requires Nightly Rust.


description:
Maximum length of a chain to fit on a single line.

[Documentation](https://rust-lang.github.io/rustfmt/#chain_width)


key: color

description:
What Color option to use when none is supplied: Always, Never, Auto

[Documentation](https://rust-lang.github.io/rustfmt/#color)

### Unstable
This option requires Nightly Rust.