dotnet-releases-index.json

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

$comment: If we targeted draft-07 we could use the 'date' format instead of this format pattern. We cannot use the 'date-time' format because our existing values don't validate against it.

description: A SemVer-compatible version string

enum: sts lts

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

$comment: If we targeted draft-06 we could use oneOf/const in combination to add descriptions to the enum values

enum: preview go-live active maintenance eol

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

title: ProductVersion

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

$ref: #/definitions/dateYYYYMMDD

title: EndOfLifeDate

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.

title: LatestReleaseIncludesSecurityUpdate

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

title: LatestReleaseDate

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

$ref: #/definitions/releaseVersion

title: LatestReleaseVersion

description: The version of the latest release

title: LatestRuntimeVersion

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

title: LatestSdkVersion

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.

title: ProductName

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.

$comment: Since this is always an absolute uri, the 'uri' format is unambiguous

$ref: #/definitions/releaseType

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

$ref: #/definitions/supportPhase

description: The support phase of the Product.

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

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

description: A collection of all released products

$ref: #/definitions/product

title: JSON schema for .NET product collection manifests


const: swagger-codegen

title: swagger codegen

type: object

description: swagger-codegen Configuration

type: array

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

title: schema

required: name actions

type: string

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

type: boolean

description: Disables all actions over this schema.

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

title: action

description: Defines a download schema task.

required: type sourceUrl id

const: download

description: Type of action to apply.

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

type: number

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

$ref: #/definitions/disable

title: action

description: Defines a TS code generator task.

required: type ngVersion id downloadId

const: generate

description: Type of action to apply.

$ref: #/definitions/version

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

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

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

title: action

description: Defines a code correction task.

required: type generateId

const: correction

description: Type of action to apply.

$ref: #/definitions/generateId

title: action

description: Defines a TS code builder task.

required: type typescriptVersion id generateId

const: build

description: Type of action to apply.

description: Specifies TypeScript version to install before build.

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

title: action

description: Defines a `npm publish` task.

required: type registryUrl token id

const: publish

description: Type of action to apply.

description: The Url of registry accepting this respository.

description: Token to use access registry.

$ref: #/definitions/buildId

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

title: action

description: Defines a Api install task.

required: type targetPath publishId

const: install

description: Type of action to apply.

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

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

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

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

description: Determines if this task is disabled.

description: Used to configure any part of AnyWork automation.

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

type: integer

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

required: ctype cversion

title: AnyWork Automation Configuration schema


trunk-yaml-schema.json

description:
List of filetypes
To refer to all filetypes, use [ALL]

examples: ALL bazel-build bazel-workspace c c# c++ c++-header c++-source c-header c-source c/c++ c/c++-source css cue docker dotenv gemspec go graphql haml html java javascript json kotlin latex markdown php prettier_supported_configs proto python ruby rust sass scala shell sql starlark svg terraform toml typescript yaml zsh

description:
List of linter IDs
To refer to all linters, use [ALL]

examples: ALL actionlint ansible-lint autopep8 bandit black black-py brakeman buf-breaking buf-format buf-lint buildifier cfnlint clang-format clang-tidy clippy cue-fmt detekt detekt-explicit detekt-gradle dotenv-linter eslint flake8 git-diff-check gitleaks gofmt goimports golangci-lint hadolint haml-lint include-what-you-use isort ktlint markdownlint mypy prettier pylint rubocop rubocop-fmt rufo rustfmt scalafmt semgrep shellcheck shfmt sql-formatter standardrb stylelint stylelint-fmt svgo taplo taplo-fmt terraform terraform-fmt terraform-validate tflint yamllint yapf

description: String where "${key1} ${key2}" will be expanded into "value1 value2"

description: The last linter you'll ever need

type: string number boolean

examples: go java node python ruby rust

examples: critical debug error info off trace warn

examples: linux macos

description: Whether or not this will be run on empty files

description:
Whether linter invocations for multiple targets should be batched; used to cut down on per-invocation overhead

Causes every token containing ${target} to be expanded multiple times, e.g. 'my_linter target=${target}' would be expanded into 'my_linter target=target1 target=target2 ... target=targetN'

description: Whether Trunk can cache results for this linter

description: argv of the command to invoke the linter with

description: Whether or not we support linting the upstream version of a target

description: Whether the command is enabled to run when the linter is run. Allows some commands of a linter to be run by default without others.

description: Exit codes implying the linter experienced an internal error

description: Whether or not this linter will be run by 'trunk fmt'; default: false

description: Whether the linter modifies ${target} files in-place.

description: Output type of this linter; controls how `trunk` parses its output

examples: actionlint ansible_lint arcanist bandit brakeman buf buildifier cfnlint clippy detekt_gradle diff eslint gitleaks golangci_lint hadolint haml_lint iwyu llvm lsp_json markdownlint mypy pass_fail pylint regex rewrite rubocop sarif semgrep shellcheck shfmt stylelint taplo terraform_validate

description: Command to initialize the linter with

description:
Tell parser where to expect output from for reading (if 'tmpfile', then the linter should write its output to ${tmpfile})

NOTE: this field is only respected for type=sarif linters currently

description: Command to invoke the linter with (write as if you were typing into your shell)

examples: "${linter}" will expand to the directory a linter is installed into, e.g. "${linter}/node_modules/.bin" is appended to the `PATH` of any linter with `runtime: node`

examples: "${runtime}" will expand to the directory a runtime is installed into, e.g. with `runtime: node`, "${runtime}/bin/npm" will yield the path to the installed NPM binary

description: The nearest target to search for when 'run_linter_from' is 'root_file' or 'root_directory'

description:
What to use as the current working directory:
  * workspace - the root of the repository
  * parent_directory - the directory containing the linter target
  * directory - the linter target itself, with the condition that the linter target is a directory itself
  * root_file - the nearest directory containing 'run_from_root_target', e.g. the nearest directory containing a go.mod file
  * root_directory - the nearest directory matching 'run_from_root_target', e.g. the nearest src/ directory

description: Whether or not this linter takes its input from stdin

description: Exit codes corresponding to no issues found or issues found

description: The download containing this linter (i.e. the `name` of an entry in `downloads`)

description: Environment variables set when `trunk` runs the linter

description: The envvar will be set to the `:`-joined list

description: Extra packages needed to run this linter; also installed using the runtime's package manager

description: Filetypes to run this linter on

description: Whether or not this linter can handle LFS files; default: false

description: Linter ID; use this in fields like `enabled` to reference this linter

description: The package containing this linter; installed using the runtime's package manager

description: argv of the command to initialize the linter with

description: The runtime, toolchain, and package manager used to run and install a linter

description: linter@envOrVersion, where envOrVersion is either the name of an environment, the version of the main `package` if `runtime` is set, or the verson of the `download`

examples: flake8@4.0.1 { packages [ 'flake8-bugbear@21.9.2', 'flake8-docstring@1.6.0' ] }

description: Paths to exclude from linting

examples: actionlint ansible_lint arcanist bandit brakeman buf buildifier cfnlint clippy detekt_gradle diff eslint gitleaks golangci_lint hadolint haml_lint iwyu llvm lsp_json markdownlint mypy pass_fail pylint regex rewrite rubocop sarif semgrep shellcheck shfmt stylelint taplo terraform_validate

description: See https://docs.trunk.io

description: The trunk config version being parsed. The only possible value is 0.1.

title: Configuration schema for trunk, a powerful linter runner - https://docs.trunk.io


semantic-release.json

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

description: The branches on which releases should happen.

$ref: #/definitions/branch-object

description: The git repository URL

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}

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

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

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

title: semantic-release Schema


vsix-publish.json

title: Description

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

title: DisplayName

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

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

title: InstallTargets

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

title: InstallTarget

description: An installation target for the extension.

required: sku version

title: Install target SKU

description: The SKU name of the installation target.

title: Install target version range

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

title: Internal name

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

type: string number

title: Language

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

title: Tags

description: A list of tags for the extension.

title: Tag

description: A tag for the extension.

title: Version

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

title: VsixId

description: The vsix identifier of the extension.

title: AssetFiles

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

required: pathOnDisk targetPath

title: PathOnDisk

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

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

title: Categories

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

title: Category

description: A valid category on the marketplace 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

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

title: PriceCategory

description: The pricing model for the extension.

default: free

enum: free trial paid

title: Publisher

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

title: Private

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

title: Q&A

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

title: Repo

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

format: uri

required: categories identity overview publisher


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

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

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

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

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.

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

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

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

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

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

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

$ref: #/definitions/propertyBag

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

description: A short description of the artifact.

$ref: #/definitions/message

description: The location of the artifact.

$ref: #/definitions/artifactLocation

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

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

description: The length of the artifact in bytes.

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

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

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

description: The contents of the artifact.

$ref: #/definitions/artifactContent

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

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

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.

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.

format: date-time

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

description: A change to a single artifact.

description: The location of the artifact to change.

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

$ref: #/definitions/replacement

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

required: artifactLocation replacements

description: Represents the contents of an artifact.

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

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

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

$ref: #/definitions/multiformatMessageString

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

description: Specifies the location of an artifact.

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

format: uri-reference

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

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

description: A short description of the artifact location.

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

description: An artifact relevant to a result.

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

description: The location of the attachment.

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

$ref: #/definitions/region

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

$ref: #/definitions/rectangle

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

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

description: A message relevant to the code flow.

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

$ref: #/definitions/threadFlow

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

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

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

$ref: #/definitions/reportingConfiguration

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

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

required: configuration descriptor

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.

description: A tool object that describes the converter.

$ref: #/definitions/tool

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

$ref: #/definitions/invocation

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

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

description: Represents a directed edge in a graph.

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

description: A short description of the edge.

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

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

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

required: id sourceNodeId targetNodeId

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

description: Identifies the edge being traversed.

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

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

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.

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

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.

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

$ref: #/definitions/stack

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

$ref: #/definitions/exception

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

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

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

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

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

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

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

$ref: #/definitions/conversion

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

$ref: #/definitions/graph

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

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

$ref: #/definitions/artifact

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

description: The location of the external property file.

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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.

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

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

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

description: Represents a path through a graph.

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

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

description: A description of this graph traversal.

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

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

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

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

description: The runtime environment of the analysis tool run.

description: The command line used to invoke the tool.

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

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

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.

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.

description: The process exit code.

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

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

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

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

description: The reason for the process exit.

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

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

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

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

description: The machine that hosted the analysis tool run.

description: The account that ran the analysis tool.

description: The process id for the analysis tool run.

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

description: The working directory for the analysis tool run.

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

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

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

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

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

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

description: A location within a programming artifact.

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

description: Identifies the artifact and region.

description: The logical locations associated with the result.

description: A message relevant to the location.

description: A set of regions relevant to the location.

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

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

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

description: A reference to the related location.

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

description: A description of the location relationship.

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

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

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

description: The index within the logical locations array.

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

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.

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.

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.

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

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

description: A plain text message string.

description: A Markdown message string.

description: The identifier for this message.

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

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

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.

description: Represents a node in a graph.

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

description: A short description of the node.

description: A code location associated with the node.

description: Array of child nodes.

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

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

description: The locations relevant to this notification.

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

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

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

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

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

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

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

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

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

description: The address of the location.

description: The location of the artifact.

description: Specifies a portion of the artifact.

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.

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

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

description: An area within an image.

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

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

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

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

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.

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

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

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

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

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

description: The length of the region in characters.

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

description: The length of the region in bytes.

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

description: A message relevant to the region.

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

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

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

description: The region of the artifact to delete.

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

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

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

description: A stable, opaque identifier for the report.

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

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

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.

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

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

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.

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

description: A set of name/value pairs with arbitrary names. 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.

description: Default reporting configuration information.

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

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

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

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

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

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

description: Specifies the failure level for the report.

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

description: Contains configuration information specific to a report.

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

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

description: The id of the descriptor.

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

description: A guid that uniquely identifies the descriptor.

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.

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

description: A reference to the related reporting descriptor.

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

description: A description of the reporting descriptor relationship.

description: A result produced by an analysis tool.

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.

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

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

description: A value that categorizes results by evaluation state.

enum: notApplicable pass fail review open informational

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

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

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.

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.

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

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

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

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

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

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

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

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

description: A set of locations relevant to this result.

description: A set of suppressions relevant to this result.

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

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

description: A set of artifacts relevant to the result.

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

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

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

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

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

description: A web request associated with this result.

description: A web response associated with this result.

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

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

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.

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.

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

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

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

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

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

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

description: Describes the invocation of the analysis tool.

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

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

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

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

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

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

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

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.

description: Automation details that describe this run.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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.

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

description: A message relevant to this call stack.

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

description: A function call within a stack trace.

description: The location to which this stack frame refers.

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

description: The thread identifier of the stack frame.

description: The parameters of the call that is executing.

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

description: A suppression that is relevant to a result.

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

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

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

description: A string representing the justification for the suppression.

description: Identifies the location associated with the suppression.

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

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

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

description: A message relevant to the thread flow.

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

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

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.

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

description: The index within the run threadFlowLocations array.

description: The code location.

description: The call stack leading to this location.

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

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

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.

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

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

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

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

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

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

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

description: The analysis tool that was run.

description: The analysis tool that was run.

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.

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

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

description: The name of the tool component.

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

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

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

description: A brief description of the tool component.

description: A comprehensive description of the tool component.

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

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

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

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

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

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

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

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.

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

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

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

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

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

description: The kinds of data contained in this object.

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.

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.

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.

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

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

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

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

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

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

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.

description: The full name associated with the translation metadata.

description: A brief description of the translation metadata.

description: A comprehensive description of the translation metadata.

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

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.

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

description: The absolute URI of the repository.

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

description: The name of a branch containing the revision.

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

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.

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

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

description: Describes an HTTP request.

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

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

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

description: The target of the request.

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

description: The request headers.

description: The request parameters.

description: The body of the request.

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

description: Describes the response to an HTTP request.

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

description: The response status code. Example: 451.

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

description: The response headers.

description: The body of the response.

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

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

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

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

description: The SARIF format version of this log file.

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

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

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

title: Static Analysis Results Format (SARIF) Version 2.1.0-rtm.4 JSON Schema


cloudbuild.json

description: A step in the build pipeline.

description:
Required. The name of the container image that will run this particular
build step.

If the image is available in the host's Docker daemon's cache, it
will be run directly. If not, the host will attempt to pull the image
first, using the builder service account's credentials if necessary.

The Docker daemon's cache will already have the latest versions of all of
the officially supported build steps
([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).
The Docker daemon will also have cached many of the layers for some popular
images, like "ubuntu", "debian", but they will be refreshed at the time you
attempt to use them.

If you built an image in a previous build step, it will be stored in the
host's Docker daemon's cache and is available to use as the name for a
later build step.

description:
The ID(s) of the step(s) that this build step depends on.
This build step will not start until all the build steps in `wait_for`
have completed successfully. If `wait_for` is empty, this build step will
start when all previous build steps in the `Build.Steps` list have
completed successfully.

description:
A list of environment variable definitions to be used when running a step.

The elements are of the form "KEY=VALUE" for the environment variable "KEY"
being given the value "VALUE".

description:
Entrypoint to be used instead of the build step image's default entrypoint.
If unset, the image's default entrypoint is used.

description:
List of volumes to mount into the build step.

Each volume is created as an empty volume prior to execution of the
build step. Upon completion of the build, volumes and their contents are
discarded.

Using a named volume in only one step is not valid as it is indicative
of a build request with an incorrect configuration.

$ref: #/definitions/Volume

description:
A list of arguments that will be presented to the step when it is started.

If the image used to run the step's container has an entrypoint, the `args`
are used as arguments to that entrypoint. If the image does not define
an entrypoint, the first element in args is used as the entrypoint,
and the remainder will be used as arguments.

description:
Time limit for executing this build step. If not defined, the step has no
time limit and will be allowed to continue to run until either it completes
or the build itself times out.

format: google-duration

description:
Unique identifier for this build step, used in `wait_for` to
reference this build step as a dependency.

description:
A list of environment variables which are encrypted using a Cloud Key
Management Service crypto key. These values must be specified in the
build's `Secret`.

description:
Working directory to use when running this step's container.

If this value is a relative path, it is relative to the build's working
directory. If this value is absolute, it may be outside the build's working
directory, in which case the contents of the path may not be persisted
across build step executions, unless a `volume` for that path is specified.

If the build specifies a `RepoSource` with `dir` and a step with a `dir`,
which specifies an absolute path, the `RepoSource` `dir` is ignored for
the step's execution.

description: Optional arguments to enable specific features of builds.

description: Compute Engine machine type on which to run the build.

enumDescriptions:
e2 HighCPU: 2 vCPUs, 2GB RAM
e2 HighCPU: 4 vCPUs, 4GB RAM
e2 HighCPU: 8 vCPUs, 8GB RAM
e2 HighCPU: 16 vCPUs, 16GB RAM
e2 HighCPU: 32 vCPUs, 32GB RAM
e2 HighMem: 2 vCPUs, 16GB RAM
e2 HighMem: 4 vCPUs, 32GB RAM
e2 HighMem: 8 vCPUs, 64GB RAM
e2 HighMem: 16 vCPUs, 128GB RAM
e2 Medium: 1 vCPU, 4GB RAM
e2 Standard: 2 vCPU, 8GB RAM
e2 Standard: 4 vCPU, 16GB RAM
e2 Standard: 8 vCPU, 32GB RAM
e2 Standard: 16 vCPU, 64GB RAM
e2 Standard: 32 vCPU, 128GB RAM
n1 HighCPU: 8 vCPUs, 7.2GB RAM
n1 HighCPU: 32 vCPUs, 28.8GB RAM
e2 Medium: 1 vCPU, 4GB RAM

description:
Global list of volumes to mount for ALL build steps

Each volume is created as an empty volume prior to starting the build
process. Upon completion of the build, volumes and their contents are
discarded. Global volume names and paths cannot conflict with the volumes
defined a build step.

Using a global volume in a build with only one step is not valid as
it is indicative of a build request with an incorrect configuration.

description:
Option to define build log streaming behavior to Google Cloud
Storage.

enumDescriptions: Service may automatically determine build log streaming behavior.

enumDescriptions: Build logs should be streamed to Google Cloud Storage.

enumDescriptions:
Build logs should not be streamed to Google Cloud Storage; they will be
written when the build is completed.

description:
Option to specify a `WorkerPool` for the build. User specifies the pool
with the format "[WORKERPOOL_PROJECT_ID]/[WORKERPOOL_NAME]".
This is an experimental field.

description:
A list of global environment variable definitions that will exist for all
build steps in this build. If a variable is defined in both globally and in
a build step, the variable will use the build step value.

The elements are of the form "KEY=VALUE" for the environment variable "KEY"
being given the value "VALUE".

description:
Option to specify the logging mode, which determines where the logs are
stored.

enumDescriptions:
The service determines the logging mode. The default is `LEGACY`. Do not
rely on the default logging behavior as it may change in the future.

enumDescriptions: Stackdriver logging and Cloud Storage logging are enabled.

enumDescriptions: Only Cloud Logging is enabled. Note that logs for both the Cloud Console UI and Cloud SDK are based on Cloud Storage logs, so neither will provide logs if this option is chosen.

enumDescriptions: Turn off all logging. No build logs will be captured.

description: Requested verifiability options.

enumDescriptions:
Not a verifiable build. (default)
Verified build.

description:
Option to specify behavior when there is an error in the substitution
checks.

enumDescriptions:
Fails the build if error in substitutions checks, like missing
a substitution in the template or in the map.

enumDescriptions: Do not fail the build if error in substitutions checks.

description:
Requested disk size for the VM that runs the build. Note that this is *NOT*
"disk free"; some of the space will be used by the operating system and
build utilities. Also note that this is the minimum disk size that will be
allocated for the build -- the build may run with a larger disk than
requested. At present, the maximum disk size is 1000GB; builds that request
more than the maximum are rejected with an error.

description:
A list of global environment variables, which are encrypted using a Cloud
Key Management Service crypto key. These values must be specified in the
build's `Secret`. These variables will be available to all build steps
in this build.

enumDescriptions:
No hash requested.
Use a sha256 hash.
Use a md5 hash.

description: Requested hash for SourceProvenance.

description:
Pairs a set of secret environment variables containing encrypted
values with the Cloud KMS key to use to decrypt the value.

description: Cloud KMS key name to use to decrypt these envs.

format: byte

description:
Map of environment variable name to its encrypted value.

Secret environment variables must be unique across all of a build's
secrets, and must be used by at least one build step. Values can be at most
64 KB in size. There can be at most 100 secret values across all of a
build's secrets.

description: Location of the source in a supported storage service.

description: If provided, get the source from this location in Google Cloud Storage.

$ref: #/definitions/StorageSource

description:
If provided, get the source from this location in a Cloud Source
Repository.

$ref: #/definitions/RepoSource

description: Location of the source in an archive file in Google Cloud Storage.

description:
Google Cloud Storage generation for the object. If the generation is
omitted, the latest generation will be used.

description:
Google Cloud Storage bucket containing the source (see
[Bucket Name
Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

description:
Google Cloud Storage object containing the source.

This object must be a gzipped archive file (`.tar.gz`) containing source to
build.

$id: StorageSource

description: Location of the source in a Google Cloud Source Repository.

description: Name of the tag to build.

description:
ID of the project that owns the Cloud Source Repository. If omitted, the
project ID requesting the build is assumed.

description:
Name of the Cloud Source Repository. If omitted, the name "default" is
assumed.

description: Explicit commit SHA to build.

description:
Directory, relative to the source root, in which to run the build.

This must be a relative path. If a step's `dir` is specified and is an
absolute path, this value is ignored for that step's execution.

description: Name of the branch to build.

description:
Artifacts produced by a build that should be uploaded upon
successful completion of all build steps.

description:
A list of objects to be uploaded to Cloud Storage upon successful
completion of all build steps.

Files in the workspace matching specified paths globs will be uploaded to
the specified Cloud Storage location using the builder service account's
credentials.

The location and generation of the uploaded objects will be stored in the
Build resource's results field.

If any objects fail to be pushed, the build is marked FAILURE.

$ref: #/definitions/ArtifactObjects

description:
A list of images to be pushed upon the successful completion of all build
steps.

The images will be pushed using the builder service account's credentials.

The digests of the pushed images will be stored in the Build resource's
results field.

If any of the images fail to be pushed, the build is marked FAILURE.

description:
Files in the workspace to upload to Cloud Storage upon successful
completion of all build steps.

description:
Cloud Storage bucket and optional object path, in the form
"gs://bucket/path/to/somewhere/". (see [Bucket Name
Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).

Files in the workspace matching any path pattern will be uploaded to
Cloud Storage with this location as a prefix.

description: Path globs used to match files in the build's workspace.

description:
Volume describes a Docker container volume which is mounted into build steps
in order to persist files across build step execution.

description:
Name of the volume to mount.

Volume names must be unique per build step and must be valid names for
Docker volumes. Each named volume must be used by at least two build steps.

description:
Path at which to mount the volume.

Paths must be absolute and cannot conflict with other volume paths on the
same build step or with certain reserved volume paths.

description:
A build resource in the Cloud Build API.

At a high level, a `Build` describes where to find source code, how to build
it (for example, the builder image to run on the source), and where to store
the built artifacts.

Fields can include the following variables, which will be expanded when the
build is created:

- $PROJECT_ID: the project ID of the build.
- $BUILD_ID: the autogenerated ID of the build.
- $REPO_NAME: the source repository name specified by RepoSource.
- $BRANCH_NAME: the branch name specified by RepoSource.
- $TAG_NAME: the tag name specified by RepoSource.
- $REVISION_ID or $COMMIT_SHA: the commit SHA specified by RepoSource or
  resolved from the specified branch or tag.
- $SHORT_SHA: first 7 characters of $REVISION_ID or $COMMIT_SHA.

$ref: #/definitions/BuildStep

description: Required. The operations to be performed on the workspace.

description:
Google Cloud Storage bucket where logs should be written (see
[Bucket Name
Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
Logs file names will be of the format `${logs_bucket}/log-${build_id}.txt`.

description: Tags for annotation of a `Build`. These are not docker tags.

description: Substitutions data for `Build` resource.

description:
A list of images to be pushed upon the successful completion of all build
steps.

The images are pushed using the builder service account's credentials.

The digests of the pushed images will be stored in the `Build` resource's
results field.

If any of the images fail to be pushed, the build status is marked
`FAILURE`.

$ref: #/definitions/BuildOptions

description: Special options for this build.

$ref: #/definitions/Source

description: The location of the source files to build.

$ref: #/definitions/Artifacts

description:
Artifacts produced by the build that should be uploaded upon
successful completion of all build steps.

description:
Amount of time that this build should be allowed to run, to second
granularity. If this amount of time elapses, work on the build will cease
and the build status will be `TIMEOUT`.

Default time is ten minutes.

description: Secrets to decrypt using Cloud Key Management Service.

$ref: #/definitions/Secret

description: Use this field to specify the IAM service account to use at build time.

pattern: ^projects/\w+/serviceAccounts/\w+$

title: Google Cloud Build build config file


title: Unknown field

title: strmprivacy.api.entities.v1.AzureClientSecretCredential client_secret_credential = 3;

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

title: string container_name = 2;

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

title: string storage_account_uri = 1;

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.

title: Unknown field

title: string field = 1;

title: strmprivacy.api.entities.v1.ConsentLevels

title: map<string, strmprivacy.api.entities.v1.ConsentLevels> field_patterns = 2;

title: Unknown field

title: strmprivacy.api.entities.v1.CsvConfig csv = 1;

title: strmprivacy.api.entities.v1.DatabaseConfig database = 2;

title: Unknown field

title: strmprivacy.api.entities.v1.ConsentConfig consent = 4;

title: strmprivacy.api.entities.v1.DerivedData

title: repeated strmprivacy.api.entities.v1.DerivedData derived_data = 9;

title: strmprivacy.api.entities.v1.EncryptedData encrypted_data = 7;

title: strmprivacy.api.entities.v1.EncryptionConfig encryption = 5;

title: strmprivacy.api.entities.v1.EncryptionKeysData encryption_keys_data = 8;

title: strmprivacy.api.entities.v1.EventContractRef event_contract_ref = 6;

title: string policy_id = 10;

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

title: strmprivacy.api.entities.v1.DataConnectorAndType source_data = 3;

title: strmprivacy.api.entities.v1.BatchJobState

title: repeated strmprivacy.api.entities.v1.BatchJobState states = 2;

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
*******************************

title: Unknown field

title: int32

title: repeated int32 consent_levels = 1;

title: Unknown field

title: strmprivacy.api.entities.v1.DataConnectorAndType target = 1;

title: Unknown field

title: string billing_id = 1;

deprecationMessage: Field "billing_id" is marked as deprecated

title: string id = 2;

description: the UUIDv4 of the job, generated upon creation

title: string project_id = 3;

description: the UUIDv4 of the STRM Privacy project

title: Unknown field

title: string billing_id = 1;

title: string name = 2;

description: the name of the stream

title: string project_id = 3;

description: refers to a key stream.

title: Unknown field

title: string client_id = 2;

description: Client ID of the Azure AD Application.

title: string client_secret = 3;

description: Client secret to use for authentication.

title: string tenant_id = 1;

description: Tenant ID of the Azure AD Application.

enum: DATABASE_TYPE_UNSPECIFIED 0 POSTGRES 1 MYSQL 2 BIGQUERY 3 SNOWFLAKE 4

markdownEnumDescriptions:
(or 0)
(or "DATABASE_TYPE_UNSPECIFIED")
(or 1)
(or "POSTGRES")
(or 2)
(or "MYSQL")
(or 3)
(or "BIGQUERY")
(or 4)
(or "SNOWFLAKE")

title: Unknown field

title: strmprivacy.api.entities.v1.ConsentLevelType consent_level_type = 3;

title: int32

title: repeated int32 consent_levels = 2;

title: strmprivacy.api.entities.v1.MaskedFields masked_fields = 4;

title: Unknown field

title: strmprivacy.api.entities.v1.MicroAggregationConfig aggregation_config = 6;

description: Configuration specifically for the aggregation algorithm.

title: strmprivacy.api.entities.v1.DataContractRef data_contract_ref = 5;

title: strmprivacy.api.entities.v1.DataConnectorAndType target_data = 4;

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
*******************************

title: Unknown field

title: string billing_id = 1;

title: string name = 2;

description:
the name of the stream
constraints: generic name

title: string project_id = 3;

description: refers to a event stream.

pattern: s$

title: Unknown field

title: string message = 3;

title: strmprivacy.api.entities.v1.BatchJobStateType state = 2;

title: google.protobuf.Timestamp state_time = 1;

title: Unknown field

title: string charset = 1;

title: Unknown field

title: string

title: repeated string aggregation_fields = 2;

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

title: int32 minimum_k_anonymity = 1;

description: The desired k-anonymity level.

title: Unknown field

title: strmprivacy.api.entities.v1.DataConnectorRef data_connector_ref = 8;

title: bool include_existing_events = 7;

title: google.protobuf.Duration interval = 4;

description: granularity of seconds, nanos is unused

title: strmprivacy.api.entities.v1.KeyStreamRef key_stream_ref = 3;

title: string path_prefix = 6;

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

title: string sink_name = 5;

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

deprecationMessage: Field "sink_name" is marked as deprecated

title: strmprivacy.api.entities.v1.StreamRef stream_ref = 2;

description: A batch exporter.

title: Unknown field

title: strmprivacy.api.entities.v1.BatchExporter

title: repeated strmprivacy.api.entities.v1.BatchExporter batch_exporters = 1;

title: strmprivacy.api.entities.v1.BatchJob

title: repeated strmprivacy.api.entities.v1.BatchJob batch_jobs = 2;

title: repeated strmprivacy.api.entities.v1.MicroAggregationBatchJob micro_aggregation_batch_jobs = 3;

title: Unknown field

title: string

title: repeated string columns = 3;

title: string schema = 1;

title: string table = 2;

title: Unknown field

title: string handle = 1;

description: constraint: handle should already exist

title: string name = 2;

description: constraints: generic name constraint, unique within handle

title: string version = 3;

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

title: Unknown field

title: string billing_id = 1;

title: string name = 2;

title: string project_id = 3;

enum: CONSENT_LEVEL_TYPE_UNSPECIFIED 0 CUMULATIVE 1 GRANULAR 2

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.

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

title: Unknown field

title: strmprivacy.api.entities.v1.DataConnectorRef data_connector_ref = 1;

title: strmprivacy.api.entities.v1.DataType data_type = 4;

title: string file_name = 3;

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

title: string path_prefix = 2;

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

title: Unknown field

title: string

title: repeated string field_patterns = 1;

title: Unknown field

title: strmprivacy.api.entities.v1.AzureBlobStorageContainerLocation azure_blob_storage_container = 4;

title: strmprivacy.api.entities.v1.DataConnectorDependentEntities dependent_entities = 6;

title: strmprivacy.api.entities.v1.GoogleCloudStorageBucketLocation google_cloud_storage_bucket = 3;

title: strmprivacy.api.entities.v1.JdbcLocation jdbc_location = 7;

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

title: strmprivacy.api.entities.v1.AwsS3BucketLocation s3_bucket = 2;

title: string uuid = 5;

title: Unknown field

title: string handle = 1;

description: constraint: handle should already exist

title: string name = 2;

title: string version = 3;

title: Unknown field

title: string billing_id = 1;

title: string name = 2;

title: string project_id = 3;

title: Unknown field

title: string bucket_name = 1;

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

title: string credentials = 2;

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.

title: Unknown field

title: strmprivacy.api.entities.v1.DatabaseType database_type = 3;

title: string jdbc_uri = 1;

title: string private_key = 2;

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

title: Unknown field

title: string batch_job_group_id = 2;

title: strmprivacy.api.entities.v1.TimestampConfig timestamp_config = 1;

enum: BATCH_JOB_STATE_TYPE_UNSPECIFIED 0 PENDING 1 STARTED 2 ERROR_STARTING 3 RUNNING 4 FINISHED 5 ERROR 6

title: Unknown field

title: strmprivacy.api.entities.v1.ConsentLevelExtractor consent_level_extractor = 2;

title: int32

title: repeated int32 default_consent_levels = 1;

title: Unknown field

title: strmprivacy.api.entities.v1.MaskedFields.PatternList

title: map<string, strmprivacy.api.entities.v1.MaskedFields.PatternList> field_patterns = 3;

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.

title: string hash_type = 1;

description: Default Murmurhash3 if empty

title: string seed = 2;

description: hashing seed

title: Unknown field

title: google.type.TimeZone default_time_zone = 3;

title: string field = 1;

description: generic field name

title: string format = 2;

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

title: Unknown field

title: string id = 1;

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

title: string version = 2;

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

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

title: Unknown field

title: string assume_role_arn = 3;

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.

title: string bucket_name = 1;

title: string credentials = 2;

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

title: Unknown field

title: strmprivacy.api.entities.v1.DataConnector


htmlhint.json

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

description: Attribute name must be lowercase.

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

description: Attribute value cant not use unsafe chars.

description: Attribute value must closed by double quotes.

description: Attribute must set value.

description: Doctype must be first.

description: Doctype must be html5.

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

description: Href must be absolute or relative.

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

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

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

description: ID attributes must be unique in the document.

description: Inline script cannot be used.

description: Inline style cannot be used.

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

description: Special characters must be escaped.

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

description: Style tag can not be used.

description: Tag must be paired.

description: The empty tag must closed by self.

description: Tagname must be lowercase.

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

title: JSON schema for HTMLHint configuration files


vsext.json

description: A unique identifier for the extension pack. This is to uniquely identify the extension pack and will not be shown to the user.

description: The name of the extension pack.

description: A short description of the extension pack.

description: The version of the extension pack.

description: A list of extension objects.

description: The name of the extension.

description: The unique ID of the extension.

title: JSON schema for Visual Studio extension pack manifests


jsone.json

type: null boolean number string integer

$ref: #/$defs/jsone-value

$ref: #/$defs/jsone-array

$ref: #/$defs/jsone-object-array

title: JSON-e templates


tmuxinator.json

description: Name of project root (deprecated, use `name`)

description: Name of project root (deprecated, use `root`)

description: Optional tmux socket.

description: Runs on project start, always.

description: Run on project start, the first time.

description: Run on project start, after the first time.

description: Run on project exit (detaching from tmux session).

description: Run on project stop.

description: Runs before everything (deprecated).

description: Runs after everything (deprecated).

description: Specify version for rbenv (deprecated)

description: Pass arguments to tmux (deprecated)

description: Specify tabs (deprecated)

description: Runs in each window and pane before window/pane specific commands. Useful for setting up interpreter versions.

description: Pass command line options to tmux. Useful for specifying a different tmux.conf.

description: Change the command to call tmux.  This can be used by derivatives/wrappers like byobu.

description: Specifies (by name or index) which window will be selected on project startup. If not set, the first window is used.

description: Specifies (by index) which pane of the specified window will be selected on project startup. If not set, the first pane is used.

description: Controls whether the tmux session should be attached to automatically. Defaults to true.

description: Deprecated. Use `attach`

description: The layout setting gets handed down to tmux directly, so you can choose from one of the five tmux standard layouts or specify your own.

description: Panes are optional and are children of window entries.


conjure.schema.json

$ref: #/definitions/TypesDefinition

$ref: #/definitions/ServiceDefinition

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

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

$ref: #/definitions/ExternalTypeDefinition

$ref: #/definitions/NamedTypesDefinition

description: The types specified in this definition.

$ref: #/definitions/ConjureType

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.

$ref: #/definitions/ExternalImportDefinition

description: The external types to reference.

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

description: The fully qualified Java type.

$ref: #/definitions/TypeName

$ref: #/definitions/AliasDefinition

$ref: #/definitions/ObjectTypeDefinition

$ref: #/definitions/UnionTypeDefinition

$ref: #/definitions/EnumTypeDefinition

$ref: #/definitions/ErrorDefinition

$ref: #/definitions/ContainerType

$ref: #/definitions/BuiltIn

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

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:

enum: any bearertoken binary boolean datetime double integer rid safelong string uuid

description: The Conjure type to be aliased.

$ref: #/definitions/LogSafety

$ref: #/definitions/DocString

$ref: #/definitions/FieldDefinition

$ref: #/definitions/UpperCase

$ref: #/definitions/EnumValueDefinition

$ref: #/definitions/PascalCase

$ref: #/definitions/ErrorCode

required: namespace code

$ref: #/definitions/PathString

$ref: #/definitions/AuthDefinition

$ref: #/definitions/EndpointDefinition

required: name package endpoints

pattern: ^(GET|DELETE|POST|PUT) .*$

$ref: #/definitions/ArgumentDefinition


jmdsl-config-schema.json

title: cli configuration

description: Defines configuration to be used with cli

title: recorder command configuration

description: Initial URL to start recording from

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

default: recording

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

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

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)(\?.*)?

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

description: Regular expressions used to ignore matching headers from recording

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

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

title: correlation

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

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

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

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


github-issue-config.json

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

title: contact links

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

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

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

title: GitHub issue template chooser config file schema