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.

type: array

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.

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 invocation 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 invocation 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 on which the invocation occurred.

description: The account under which the invocation occurred.

description: The id of the process in which the invocation occurred.

description: An absolute URI specifying the location of the executable that was invoked.

description: The working directory for the invocation.

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 result is relevant.

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 review status 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.5 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.5 JSON Schema


label-commenter-config.json

type: object

title: Body

type: string

title: Action

title: Locking

enum: lock unlock

title: Lock Reason

title: Issue

$ref: #/definitions/labelItem

title: Pull Request

title: Labeled

$ref: #/definitions/labelFor

title: Unlabeled

description: Configuration for Actions Label Commenter, for posting messages triggered by labels.

title: Comment

title: Header

title: Footer

title: Labels

title: Label

$ref: #/definitions/labelType

title: Name


description: General information about the API.

required: version title

$ref: #/definitions/vendorExtension

description: A unique and precise title of the API.

description: A semantic version number of the API.

description: A longer description of the API. Should be different from the title.  GitHub Flavored Markdown is allowed.

description: The terms of service for the API.

$ref: #/definitions/contact

$ref: #/definitions/license

description: Contact information for the owners of the API.

description: The identifying name of the contact person/organization.

description: The URL pointing to the contact information.

format: uri

description: The email address of the contact person/organization.

format: email

description: The name of the license type. It's encouraged to use an OSI compatible license.

description: The URL pointing to the license.

description: Relative paths to the individual endpoints. They must be relative to the 'basePath'.

$ref: #/definitions/pathItem

$ref: #/definitions/schema

description: One or more JSON objects describing the schemas being consumed and produced by the API.

$ref: #/definitions/parameter

description: One or more JSON representations for parameters

$ref: #/definitions/response

description: One or more JSON representations for responses

description: information about external documentation

description: The MIME type of the HTTP message.

description: A brief summary of the operation.

description: A longer description of the operation, GitHub Flavored Markdown is allowed.

$ref: #/definitions/externalDocs

description: A unique identifier of the operation.

description: A list of MIME types the API can produce.

$ref: #/definitions/mediaTypeList

description: A list of MIME types the API can consume.

$ref: #/definitions/parametersList

$ref: #/definitions/schemesList

type: boolean

$ref: #/definitions/security

$ref: #/definitions/operation

description: Response objects names can either be any valid HTTP status code or 'default'.

$ref: #/definitions/jsonReference

$ref: #/definitions/header

enum: string number integer boolean array

$ref: #/definitions/primitivesItems

$ref: #/definitions/collectionFormat

$ref: #/definitions/default

$ref: #/definitions/maximum

$ref: #/definitions/exclusiveMaximum

$ref: #/definitions/minimum

$ref: #/definitions/exclusiveMinimum

$ref: #/definitions/maxLength

$ref: #/definitions/minLength

$ref: #/definitions/pattern

$ref: #/definitions/maxItems

$ref: #/definitions/minItems

$ref: #/definitions/uniqueItems

$ref: #/definitions/enum

$ref: #/definitions/multipleOf

description: Any property starting with x- is valid.

required: name in schema

description: A brief description of the parameter. This could contain examples of use.  GitHub Flavored Markdown is allowed.

description: The name of the parameter.

description: Determines the location of the parameter.

description: Determines whether or not this parameter is required or optional.

description: The name of the parameter.

description: The name of the parameter.

description: allows sending a parameter by name only or with an empty value.

description: The name of the parameter.

enum: string number boolean integer array file

description: The name of the parameter.

description: A deterministic version of a JSON Schema object.

description: The parameters needed to send a valid API call.

description: The transfer protocol of the API.

description: The Swagger version of this document.

description: The host (name or ip) of the API. Example: 'swagger.io'

description: The base path to the API. Example: '/api'.

description: A list of MIME types accepted by the API.

title: A JSON Schema for Swagger 2.0 API.


github-issue-forms.json

description:
A form item type
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#keys

enum: checkboxes dropdown input markdown textarea

title: validation options

description: Specify whether require a form item

title: form item

description:
A form item
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#about-githubs-form-schema

$ref: #/definitions/type

const: markdown

$comment: For `additionalProperties` to work `type` must also be present here.

title: markdown

description:
Markdown
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#markdown

required: type attributes

title: markdown attributes

description:
Markdown attributes
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes

description:
A markdown code
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes

const: textarea

title: textarea

description:
Textarea
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#textarea

description:
A textarea id
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#keys

$ref: #/definitions/id

title: textarea attributes

description:
Textarea attributes
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-1

description:
A short textarea description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-1

$ref: #/definitions/label

description:
A long textarea description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-1

$ref: #/definitions/description

description:
A textarea placeholder
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-1

$ref: #/definitions/placeholder

description:
A textarea value
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-1

$ref: #/definitions/value

description:
A textarea syntax highlighting mode
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-1

enum:
1C Enterprise
4D
ABAP CDS
ABAP
ABNF
AFDKO
AGS Script
AIDL
AL
AMPL
ANTLR
API Blueprint
APL
ASL
ASN.1
ASP.NET
ATS
ActionScript
Ada
Alloy
Alpine Abuild
Altium Designer
AngelScript
Ant Build System
ApacheConf
Apex
Apollo Guidance Computer
AppleScript
Arc
AsciiDoc
AspectJ
Assembly
Astro
Asymptote
Augeas
AutoHotkey
AutoIt
AutoIt3
AutoItScript
Avro IDL
Awk
BASIC
Ballerina
Batchfile
Beef
Befunge
BibTeX
Bicep
Bison
BitBake
Blade
BlitzBasic
BlitzMax
Boo
Boogie
Brainfuck
Brightscript
Browserslist
C
C#
C++
C-ObjDump
C2hs Haskell
CIL
CLIPS
CMake
COBOL
CODEOWNERS
COLLADA
CSON
CSS
CSV
CUE
CWeb
Cabal Config
Cabal
Cap'n Proto
Carto
CartoCSS
Ceylon
Chapel
Charity
ChucK
Cirru
Clarion
Classic ASP
Clean
Click
Clojure
Closure Templates
Cloud Firestore Security Rules
CoNLL
CoNLL-U
CoNLL-X
ColdFusion CFC
ColdFusion
Common Lisp
Common Workflow Language
Component Pascal
Containerfile
Cool
Coq
Cpp-ObjDump
Crystal
Csound Document
Csound Score
Csound
Cuda
Cue Sheet
Cycript
Cython
D-ObjDump
DIGITAL Command Language
DM
DTrace
Dafny
Darcs Patch
Dart
DataWeave
Dhall
Diff
Dlang
Dockerfile
Dogescript
Dylan
E
E-mail
EBNF
ECL
ECLiPSe
EJS
EQ
Eagle
Earthly
Easybuild
Ecere Projects
EditorConfig
Eiffel
Elixir
Elm
Emacs Lisp
EmberScript
Erlang
F#
F*
FIGfont
FIGlet Font
FLUX
Factor
Fancy
Fantom
Faust
Fennel
Filebench WML
Filterscript
Fluent
Formatted
Forth
Fortran Free Form
Fortran
FreeBasic
Frege
Futhark
G-code
GAML
GAMS
GAP
GCC Machine Description
GDB
GDScript
GEDCOM
GLSL
GN
Game Maker Language
Gemfile.lock
Genie
Genshi
Gentoo Eclass
Gerber Image
Gettext Catalog
Gherkin
Git Config
Glyph Bitmap Distribution Format
Glyph
Gnuplot
Go Checksums
Go Module
Go
Golo
Gosu
Grace
Gradle
Grammatical Framework
Graph Modeling Language
GraphQL
Graphviz (DOT)
Groovy Server Pages
Groovy
HAProxy
HCL
HTML
HTML+ECR
HTML+EEX
HTML+ERB
HTML+PHP
HTML+Razor
HTTP
HXML
Hack
Haml
Handlebars
Harbour
HashiCorp Configuration Language
Haskell
Haxe
HiveQL
HolyC
Hy
IDL
IGOR Pro
IPython Notebook
Idris
Ignore List
ImageJ Macro
Inform 7
Io
Ioke
Isabelle ROOT
Isabelle
J
JAR Manifest
JFlex
JSON with Comments
JSON
JSON5
JSONLD
JSONiq
Jasmin
Java Properties
Java Server Pages
Java
JavaScript
JavaScript+ERB
Jest Snapshot
Jinja
Jison Lex
Jison
Jolie
Jsonnet
Julia
Jupyter Notebook
Kaitai Struct
KakouneScript
KiCad Layout
KiCad Legacy Layout
KiCad Schematic
Kit
Kotlin
Kusto
LFE
LLVM
LOLCODE
LSL
LTspice Symbol
LabVIEW
Lark
Lasso
Lean
Less
Lex
LilyPond
Limbo
Linker Script
Linux Kernel Module
Liquid
Literate Agda
Literate CoffeeScript
Literate Haskell
LiveScript
Logos
Logtalk
LookML
LoomScript
Lua
M
M4
M4Sugar
MATLAB
MAXScript
MLIR
MQL4
MQL5
MTML
MUF
Macaulay2
Makefile
Mako
Markdown
Marko
Mathematica
Max
Mercury
Meson
Metal
Microsoft Developer Studio Project
Microsoft Visual Studio Solution
MiniD
Mirah
Modelica
Modula-2
Modula-3
Module Management System
Monkey
Moocode
MoonScript
Motoko
Motorola 68K Assembly
Muse
Myghty
NASL
NCL
NEON
NPM Config
NSIS
NWScript
Nearley
Nemerle
NeoSnippet
NetLinx
NetLinx+ERB
NetLogo
NewLisp
Nextflow
Nginx
Ninja
Nit
Nix
NumPy
Nunjucks
ObjDump
Object Data Instance Notation
ObjectScript
Objective-C
Objective-C++
Objective-J
Odin
Omgrofl
Opa
Opal
Open Policy Agent
OpenCL
OpenEdge ABL
OpenQASM
OpenRC runscript
OpenSCAD
OpenStep Property List
OpenType Feature File
Org
Ox
Oxygene
Oz
P4
PEG.js
PHP
PLpgSQL
POV-Ray SDL
Pan
Papyrus
Parrot Assembly
Parrot Internal Representation
Parrot
Pascal
Pawn
Pep8
Perl
Pickle
PicoLisp
PigLatin
Pike
PlantUML
Pod 6
Pod
PogoScript
Pony
PostCSS
PostScript
PowerShell
Prisma
Processing
Proguard
Prolog
Promela
Propeller Spin
Protocol Buffer
Protocol Buffers
Public Key
Pug
Puppet
Pure Data
PureBasic
PureScript
Python
Q#
QMake
Qt Script
Quake
R
RAML
RDoc
REALbasic
REXX
RMarkdown
RPC
RPM Spec
Racket
Ragel
Raw token data
ReScript
Readline Config
Reason
Rebol
Record Jar
Red
Redirect Rules
Regular Expression
RenderScript
Rich Text Format
Ring
Riot
RobotFramework
Roff
Rouge
Rscript
Ruby
Rust
SAS
SCSS
SELinux Kernel Policy Language
SELinux Policy
SMT
SPARQL
SQF
SQL
SQLPL
SRecode Template
SSH Config
STON
SVG
SWIG
Sage
SaltStack
Sass
Scala
Scaml
Scheme
Scilab
Self
ShaderLab
Shell
ShellCheck Config
Sieve
Singularity
Slash
Slice
Slim
SmPL
Smalltalk
SnipMate
Solidity
Soong
SourcePawn
Spline Font Database
Squirrel
Stan
Standard ML
Starlark
StringTemplate
Stylus
SubRip Text
SugarSS
SuperCollider
Svelte
Swift
SystemVerilog
TI Program
TLA
TOML
TSQL
TSV
TSX
TXL
Tcl
Tcsh
TeX
Tea
Terra
Texinfo
Text
TextMate Properties
Textile
Thrift
Turing
Turtle
Twig
Type Language
TypeScript
UltiSnip
UltiSnips
Unified Parallel C
Unity3D Asset
Unix Assembly
Uno
UnrealScript
Ur
Ur/Web
UrWeb
V
VBA
VCL
VHDL
Vala
Valve Data Format
Verilog
Vim Help File
Vim Script
Vim Snippet
Visual Basic .NET
Vue
Wavefront Material
Wavefront Object
Web Ontology Language
WebAssembly
WebVTT
Wget Config
Wikitext
Windows Registry Entries
Wollok
World of Warcraft Addon Data
X BitMap
X Font Directory Index
X PixMap
X10
XC
XCompose
XML Property List
XML
XPages
XProc
XQuery
XS
XSLT
Xojo
Xonsh
Xtend
YAML
YANG
YARA
YASnippet
Yacc
ZAP
ZIL
Zeek
ZenScript
Zephir
Zig
Zimpl
abl
abuild
acfm
aconf
actionscript 3
actionscript3
ada2005
ada95
adobe composite font metrics
adobe multiple font metrics
advpl
ags
ahk
altium
amfm
amusewiki
apache
apkbuild
arexx
as3
asm
asp
aspx
aspx-vb
ats2
au3
autoconf
b3d
bash session
bash
bat
batch
bazel
blitz3d
blitzplus
bmax
bplus
bro
bsdmake
byond
bzl
c++-objdump
c2hs
cURL Config
cake
cakescript
cfc
cfm
cfml
chpl
clipper
coccinelle
coffee
coffee-script
coldfusion html
console
cperl
cpp
csharp
csound-csd
csound-orc
csound-sco
cucumber
curlrc
cwl
dcl
delphi
desktop
dircolors
django
dosbatch
dosini
dpatch
dtrace-script
eC
ecr
editor-config
edn
eeschema schematic
eex
elisp
emacs muse
emacs
email
eml
erb
fb
fish
flex
foxpro
fsharp
fstar
ftl
fundamental
gf
git-ignore
gitattributes
gitconfig
gitignore
gitmodules
go mod
go sum
go.mod
go.sum
golang
groff
gsp
hbs
heex
help
html+django
html+jinja
html+ruby
htmlbars
htmldjango
hylang
i7
ignore
igor
igorpro
ijm
inc
inform7
inputrc
irc logs
irc
java server page
jq
jruby
js
jsonc
jsp
kak
kakscript
keyvalues
ksy
lassoscript
latex
leex
lhaskell
lhs
lisp
litcoffee
live-script
ls
m2
m68k
mIRC Script
macruby
mail
make
man page
man
man-page
manpage
markojs
max/msp
maxmsp
mbox
mcfunction
mdoc
mediawiki
mf
mma
mumps
mupad
nanorc
nasm
ne-on
nesC
nette object notation
nginx configuration file
nixos
njk
node
npmrc
nroff
nush
nvim
obj-c
obj-c++
obj-j
objc
objc++
objectivec
objectivec++
objectivej
objectpascal
objj
octave
odin-lang
odinlang
oncrpc
ooc
openedge
openrc
osascript
pandoc
pasm
pcbnew
perl-6
perl6
pir
plain text
posh
postscr
pot
pov-ray
povray
progress
protobuf
pwsh
pycon
pyrex
python3
q
ql
qsharp
ragel-rb
ragel-ruby
rake
raw
razor
rb
rbx
reStructuredText
readline
red/system
redirects
regex
regexp
renpy
rhtml
robots txt
robots
robots.txt
rpcgen
rs
rs-274x
rss
rst
rusthon
salt
saltstate
sed
sepolicy
sh
shell-script
shellcheckrc
sml
snippet
sourcemod
soy
specfile
splus
squeak
terraform
tl
tm-properties
troff
ts
udiff
vb .net
vb.net
vb6
vbnet
vdf
vim
vimhelp
viml
visual basic 6
visual basic for applications
visual basic
vlang
wasm
wast
wdl
wgetrc
wiki
winbatch
wisp
wl
wolfram lang
wolfram language
wolfram
wsdl
xBase
xbm
xdr
xhtml
xml+genshi
xml+kid
xpm
xsd
xsl
xten
yas
yml
zsh

title: textarea validations

description:
Textarea validations
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#validations

$ref: #/definitions/validations

const: input

title: input

description:
Input
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#input

description:
An input id
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#keys

title: input attributes

description:
Input attributes
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-2

description:
A short input description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-2

description:
A long input description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-2

description:
An input placeholder
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-2

description:
An input value
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-2

title: input validations

description:
Input validations
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#validations-1

const: dropdown

title: dropdown

description:
dropdown
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#dropdown

description:
A dropdown id
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#keys

title: dropdown attributes

description:
Dropdown attributes
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-3

required: label options

description:
A short dropdown description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-3

description:
A long dropdown description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-3

description:
Specify whether allow a multiple choices
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-3

description:
Dropdown choices
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-3

title: dropdown validations

description:
Dropdown validations
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#validations-2

const: checkboxes

title: checkboxes

description:
Checkboxes
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#checkboxes

description:
Checkbox list id
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#keys

title: checkbox list attributes

description:
Checkbox list attributes
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4

description:
A short checkbox list description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4

description:
A long checkbox list description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4

description:
Checkbox list choices
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4

title: checkbox list choice

description:
Checkbox list choice
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4

description:
A short checkbox list choice description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4

description:
Specify whether a choise is required
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema#attributes-4

description:
An issue template name
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax

description:
An issue template description
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax

description:
An issue template body
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax

description:
An issue template assignees
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax

$ref: #/definitions/assignee

description:
An issue template labels
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax

examples:
Sample label
bug
documentation
duplicate
enhancement
good first issue
help wanted
invalid
question
wontfix

description:
An issue template title
https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax

examples:
Sample title
Bug:
Feature:

required: name description body

title: GitHub issue forms config file schema


docker-seq.schema.json

title: docker-seq

description: The schema for `docker-seq`

description: The docker image name

description: Working directory inside the container

description: Username or UID (format: <name|uid>[:<group|gid>])

description: Disables the `user` option and runs the container with the hosts uid and gid.

description: Allocate a pseudo-TTY

description: Keep STDIN open even if not attached

description: Pull image before running ("always"|"missing"|"never") (default "missing")

enum: always missing never

description: Automatically remove the container when it exits

description: Run an init inside the container that forwards signals and reaps processes

description: Bind mount volumes

description: Publish a container's port(s) to the host

description: Set environment variables

description: Read in files of environment variables

description: Number of CPUs

type: integer

description: Memory limit in bytes

description: Overwrite the default ENTRYPOINT of the image

description: Assign a name to the container

description: Give extended privileges to this container

description: Attach a filesystem mount to the container

description: Mount the container's root filesystem as read only

description: Set platform if server is multi-platform capable

description: Runtime to use for this container

description: Security Options

description: Ulimit options

description: Mount volumes from the specified container(s)

description: Task with which to keep the container alive while executing commands

description: Shell in which to execute each sequence step command

$ref: #/definitions/Step

description: One step in the command sequence

description: Working directory inside the container

description: Disables the `user` option and executes these commands with the hosts uid and gid.

description: Allocate a pseudo-TTY

description: Give extended privileges to the commands

description: Keep STDIN open even if not attached

description: A list of commands to execute within the container


cloud-sdk-pipeline-config-schema.json

description: The image used in the step or stage.

description: Cloud Foundry organization.

description: Cloud Foundry space.

description: Name of the application.

description: Manifest file that needs to be used.

description: ID to the credentials that will be used.

description: URL to the Cloud Foundry endpoint.

description: (Only for MTA-projects) Path to the mta extension description file. For more information on how to use those extension files please visit the SAP HANA Developer Guide.

description: (Only for MTA-projects) Map of credentials that need to be replaced in the mtaExtensionDescriptor. This map needs to be created as value-to-be-replaced:id-of-a-credential-in-jenkins

description: Host of the region you want to deploy to, see Regions.

description: Identifier of the subaccount.

description: Name of the application in your account.

description: Map of environment variables in the form of KEY: VALUE.

description: String of VM arguments passed to the JVM.

description: Size of the JVM, e.g. lite, pro, prem, prem-plus.

default: lite

description: Name of the runtime: neo-java-web, neо-javaee6-wp, neо-javaee7-wp. See the runtime for more information.

description: Version of the runtime. See runtime-version for more information.

$ref: #/definitions/host

$ref: #/definitions/account

$ref: #/definitions/application

$ref: #/definitions/credentialsId

$ref: #/definitions/environment

$ref: #/definitions/vmArguments

$ref: #/definitions/size

$ref: #/definitions/runtime

$ref: #/definitions/runtimeVersion

required: host account application runtime runtimeVersion

description: The URLs under which the app is available after deployment. Each appUrl can be a string with the URL or a map containing a property url and a property credentialId.

description: ID to the credentials that will be used to connect to the SAP Cloudplatform account.

description: Additional parameters can be passed for each end-to-end test deployment by specifying optional parameters for an application URL. These parameters are appended to the npm command during execution. These parameters must be a list of strings, where each string corresponds to one element of the parameters. For example, if the parameter `--tag scenario1` should be passed to the test, specify parameters: ['--tag', 'scenario1'].

$ref: #/definitions/org

$ref: #/definitions/space

$ref: #/definitions/appName

$ref: #/definitions/manifest

$ref: #/definitions/apiEndpoint

$ref: #/definitions/mtaExtensionDescriptor

$ref: #/definitions/mtaExtensionCredentials

description: A map specifying the Cloud Foundry specific parameters.

description: The configuration file of the SAP Cloud SDK Continuous Delivery Toolkit. For more information please visit https://github.com/SAP/cloud-s4-sdk-pipeline

description: The sendNotification post-build action can be used to send notifications to project members in case of an unsuccessful build outcome or if the build goes back to normal. By default, an email is sent to the list of users who committed a change since the last non-broken build. Additionally, a set of recipients can be defined that should always receive notifications.

description: If set to true, notifications will be sent.

description: If set to true, notifications will only be sent for the productive branch as defined in the general configuration section.

description: List of email addresses that should be notified in addition to the standard recipients.

description: List of paths or URLs to YAML files with custom defaults to consider. These defaults override built-in defaults, and can be shared across multiple projects. Project configuration takes precedence.

description: The general configuration of the pipeline

description: The name of your default branch. This branch will be used for deploying your application. Other branches will skip deployment.

default: master

description: Name of the project. Will be used as identifier e.g. when creating a hdi container or executing code scans.

description: Git url of the repository containing the extensions.

description: Version of the extensions which should be used, e.g. the tag name

description: Credentials required to clone the repository

description: No personal data is collected. For details, consult the analytics documentation.

description: Enable unsafe mode to skip checking environment variables for insecure elements. Only use this for demo purposes, never for productive usage.

description: Allows enabling or disable certain optional features.

description: Run E2E Tests in parallel. This feature is disabled by default because it is not supported in Blue Ocean. If this feature is enabled, we suggest not using the Blue Ocean interface and rely on the classic UI instead.

enum: on off

default: off

description: If the Jenkins is running on a kubernetes cluster as a pod, we can use the dynamic scaling feature in the pipeline. In order to enable this, an environment variable ON_K8S has to be set to true on the jenkins.

description: Docker image for jnlp agent to be used.

description: Configuration, which will modify the behaviour of stages in the SAP Cloud SDK Pipeline.

description: The number of times that integration tests will retry before aborting the build. Note: This will consume more time for the jenkins build.

description: The number of JVM processes that are spawned to run the tests in parallel in case of using a maven based project structure. For more details visit the surefire documentation.

description: The list of system credentials to be injected during integration tests. The following example will provide the username and password for the systems with the aliases ERP and SFSF. For this, it will use the Jenkins credentials entries erp-credentials and successfactors-credentials. You have to ensure that corresponding credential entries exist in your Jenkins configuration.

required: alias credentialId

description: Name of the Docker image that should be used.

description: On Docker: Name of the container in the local network. On Kubernetes: Name of the container.

description: Command executed inside the container, which returns exit code 0 when the container is ready to be used.

description: Environment variables to set in the container.

$ref: #/definitions/dockerImage

description: It is possible to activate zero downtime deployment in end-to-end tests with the option enableZeroDowntimeDeployment. This will lead to a blue-green-deployment on SCP Cloud Foundry respectively to a rolling update on SCP Neo. By default, this feature is turned off.

description: Running end-to-end tests can be restricted to the productiveBranch with the option onlyRunInProductiveBranch. This might be useful when the end-to-end tests slow down development, and build failure on the productiveBranch is acceptable. By default, this feature is turned off.

$ref: #/definitions/appUrls

description: This stage uses the npm audit command to check for known vulnerabilities in dependencies.

description: In case you audited an advisory, and it turns out to be a false positive, you can mark it as audited by adding its id to the auditedAdvisories in the stage configuration. A false positive in this case is when you are confident your application is not affected in any way by the underlying bug or vulnerability.

type: integer string

$ref: #/definitions/neoTargets

$ref: #/definitions/cfTargets

description: A list of exclusions expressed as an Ant-style pattern relative to the application folder. An example can be found below.

description: We recommend only using OData services listed in the in SAP API Business Hub. Despite that for using custom business objects you can add those APIs here.

description: List of destination names that do not refer to ERP systems. Use this parameter to exclude specific destinations from being checked in context of ERP API whitelists.

description: List of URLs that are not defined as destinations. Use this parameter to exclude specific URLs from being checked in context of ERP API whitelists.

description: A map containing the thresholds unstable and failing. If the code coverage is lower than what is configured in unstable, the pipeline result is unstable. If it is lower than what is configured in failing, the pipeline will fail.

description: This setting allows the code coverage to be stricter compared to the default values. By default, the pipeline will fail if the coverage is below 65% line coverage (unstableCoverage), and will be unstable if it is less than 70% (successCoverage). If lower numbers are configured, or this configuration is left out, the default values are applied.

description: A list of checks which should not be executed. Possible values are: checkDeploymentDescriptors (Check for insecure options, such as ALLOW_MOCKED_AUTH_HEADER in deployment descriptors), checkResilience(Check that application is resilient to faults in the network), checkServices (Check that only official APIs are used), checkFrontendCodeCoverage (Ensures high frontend code coverage), checkBackendCodeCoverage (Ensures high backend code coverage)

enum: checkDeploymentDescriptors checkResilience checkServices checkFrontendCodeCoverage checkBackendCodeCoverage

description: Checkmarx is one of the security analysis tools which is supported by the pipeline.

description: Checkmarx Group ID

description: Name of the project on Checkmarx server.

description: Files which needs to be skipped during scanning.

description: Toggle to enable or disable full scan on a certain schedule.

description: Perform incremental scan with every run. If turned false, complete project is scanned on every submission.

description: The threshold for medium level threats. If the findings are greater than this value, pipeline execution will result in failure.

description: The threshold for low level threats. If the findings are greater than this value, pipeline execution will result in failure.

description: Name or numerical ID of Checkmarx preset to be used when scanning this project. When a name (string) is specified, the pipeline will try to discover the corresponding numerical ID via the Checkmarx API. Please also make sure to specify checkmarxCredentialsId and checkmarxServerUrl in such a case. For determining available presets in your Checkmarx webclient, go to Checkmarx -> Management -> Scan Settings -> Preset Manager. Alternatively, you can determine the numerical ID of your targeted preset by following those guides: Token-based Authentication and Get All Preset Details.

description: The Credential ID to connect to Checkmarx server. The credentials must be type username with password. This property becomes mandatory if the credentials are not configured in the Jenkins plugin itself.

description: An URL to Checkmarx server. This property becomes mandatory if the URL to the Checkmarx server is not configured in the Jenkins plugin itself or if the checkmarxCredentialsId is configured.

description: Possibility to generate PDF reports of the scan.

description: The deployment of artifacts to nexus can be configured with a map containing the following properties.

description: Version of nexus. Can be nexus2 or nexus3.

description: URL of the nexus. The scheme part of the URL will not be considered, because only http is supported.

description: Name of the nexus repository for Maven and MTA artifacts. Ignored if the project does not contain pom.xml or mta.yml in the project root.

description: Name of the nexus repository for NPM artifacts. Ignored if the project does not contain a package.json in the project root directory.

description:
Configure credentials for WhiteSource scans. The minimum required Maven WhiteSource plugin version is 18.6.2, ensure this in the plugins section of the project pom.xml file.

Pipeline will execute npx whitesource run for npm projects. Please ensure that all package.json files have a name and version configured so that it is possible to distinguish between the different packages.

description: Name of your product in WhiteSource.

description: Overwrites the respective version in the whitesource UI per scan with the staticVersion. Per default for every new version of a pom/package.json a new project will be created in the whitesource UI. To deactivate the creation of new projects and always have a fixed version for each project in the whitesource UI, configure the staticVersion.

description: Unique identifier of the Secret Text on Jenkins server that stores WhiteSource userKey of a user. This is required only if the administrator of the WhiteSource service has enabled additional access level control. More details can be found here.

description: Configure SourceClear scans.Note: Please note that the SourceClear stage of this pipeline is not actively maintained anymore. In case of issues, feel free to contribute to this project by opening a pull request.

description: Additional configuration for the SourceClear agent. The key-value pairs will be added to srcclr.yml.

description: Configure the stage Compliance, which currently executes a SonarQube (https://www.sonarqube.org/) scan.

description: Define whether the scan should also happen in non productive branches, i.e. if your SonarQube instance supports that.

description: The mavenExecute step is used for all invocations of the mvn build tool. It is either used directly for executing specific maven phases such as test, or indirectly for steps that execute maven plugins such as checkPmd.

description: The project settings.xml to be used for maven builds. You can specify a relative path to your project root or a URL starting with http or https.

description: If automatic versioning is enabled, this step is used to set a common version for artifacts and optionally push a corresponding tag.

description: Defines the user name which appears in version control for the versioning update (in case versioningType: cloud).

description: Defines if the automatically generated version (versioningType: cloud) should include the commit id hash.

description: Defines the prefix which is used for the git tag which is written during the versioning run (only versioningType: cloud).

description: Defines if the Unix timestamp number should be used as build number instead of the standard date format.

description: Defines the type of versioning (cloud: fully automatic, cloud_noTag: automatic but no tag created, library: manual)

description: The executeNpm step is used for all invocations of the npm build tool. It is, for example, used for building the frontend and for executing end to end tests.

description: The default npm registry url to be used as the remote mirror. Bypasses the local download cache if specified.

description: A step configuration regarding Cloud Foundry deployment. This is required by stages like end-to-end tests, performance tests, and production deployment.

description: Expected return code for smoke test success.

description: In case of a blue-green deployment the old instance will be stopped and will remain in the Cloud Foundry space by default. If this option is set to false, the old instance will be deleted.

description: The map for neo.

description: Gatling is used as one of the performance tests tool.

description: You can enable Gatling tests by turning the flag to true.

description: Apache JMeter is executed as part of performance tests of the application. The user is free to choose between JMeter and Gatling or both.

description: Options such as proxy.

description: The directory where the test plans reside. Should reside in a subdirectory under performance-tests directory if both JMeter and Gatling are enabled.

description: Marks build as FAILURE if the value exceeds the threshold.

description: Marks build as UNSTABLE if the value exceeds the threshold.

description: Sends the verbose output to the Jenkins log.

description: Jenkins 'Secret text' credentials ID containing token to authenticate to Fortify SSC.

description: Jenkins 'Secret text' credentials ID containing token to authenticate to GitHub.

description: Fortify SSC Url to be used for accessing the APIs

description: The project used for reporting results in SSC

description: The default project versioning model used in case 'projectVersion' parameter is empty for creating the version based on the build descriptor version to report results in SSC, can be one of 'major', 'major-minor', 'semantic', 'full'

description: Scan type used for the step which can be 'maven', 'pip'

description: Whether Fortify project and project version shall be implicitly auto created in case they cannot be found in the backend

description: Whether results shall be uploaded or not

description: The amount of memory granted to the translate/scan executions

description: A list of source directories to scan. Wildcards can be used, e.g., 'src/main/java/**/*'. The default value for buildTool: 'maven' is ['**/*.xml', '**/*.html', '**/*.jsp', '**/*.js', '**/src/main/resources/**/*', '**/src/main/java/**/*'], for buildTool: 'pip' it is ['./**/*'].

description: A list of directories/files to be excluded from the scan. Wildcards can be used, e.g., '**/Test.java'.

description:
Configure credentials for WhiteSource scans. The minimum required Maven WhiteSource plugin version is 18.6.2, ensure this in the plugins section of the project pom.xml file.

Pipeline will execute npx whitesource run for npm projects. Please ensure that all package.json files have a name configured so that it is possible to distinguish between the different packages.

description: Name of your product in WhiteSource.

description: Overwrites the project version in the WhiteSource UI per scan with the given version. Per default, the version from the main build descriptor file is used and transformed according to the versioningModel parameter, i.e. "1" for the default model of "major".

description: The target platform to which the mtar can be deployed.

description: Choose which tool is used to build your mta project. The default option is `cloudMbt` which is not backwards compatible with the `classic` tool. For more information on migrating from `classic` to `cloudMbt`, please refer to https://sap.github.io/cloud-mta-build-tool/migration/.

description: The name of the application which is being built. If the parameter has been provided and no mta.yaml exists, the mta.yaml will be automatically generated using this parameter and the information (name and version) from package.json before the actual build starts.

description: Url to the npm registry that should be used for installing npm dependencies.

description: Docker options to be set when starting the container (List or String).

description: The path to the extension descriptor file.

description: Path or url to the mvn settings file that should be used as global settings file.

description: Path or url to the mvn settings file that should be used as project settings file.

description: The location of the SAP Multitarget Application Archive Builder jar file, including file name and extension. If it is not provided, the SAP Multitarget Application Archive Builder is expected on PATH.

description: The debugReportArchive configuration can be used to create confidential (instead of redacted) debug reports. The difference between the redacted and the confidential debug report is that potentially confidential information, such as the GitHub repository and branch, global extension repository and shared libraries, are included in the confidential debug report. It is the user's responsibility to make sure that the debug report does not contain any confidential information.

description: If set to true, a confidential debug report is being generated with each build.

description: Configure SonarQube (https://www.sonarqube.org/) scans.

description: The project key is used to refer your project.

description: This property refers to a SonarQube instance, which needs to be defined in the Jenkins.

description: A list of additional options (in the form of '-Dxy=z') to be passed to the sonar scanner tool.

description: This step allows you to upload an MTA file (multi-target application archive) and multiple MTA extension descriptors into a TMS (SAP Cloud Platform Transport Management Service) landscape for further TMS-controlled distribution through a TMS-configured landscape.

description: Defines the name of the node to which the *.mtar file should be uploaded.

description: Credentials to be used for the file and node uploads to the Transport Management Service.

description: Can be used as the description of a transport request. Will overwrite the default.

title: SAP Cloud SDK pipeline_config JSON schema


vega.json

$ref: #/defs/scope

type: number

$ref: #/defs/padding

$ref: #/defs/autosize

$ref: #/defs/background

enum: pad fit none

enum: content padding

default: pad

enum: top bottom left right

$ref: #/refs/stringOrSignal

enum: parity greedy

$ref: #/refs/tickCount

$ref: #/refs/signal

$ref: #/refs/numberValue

$ref: #/defs/guideEncode

required: orient scale

$ref: #/refs/element

required: input options

title: Input data set definition

$ref: #/defs/transform

$ref: #/defs/onTrigger

enum: boolean number date string

enum: csv tsv

title: Mark encode property set

enum: none left right top bottom top-left top-right bottom-left bottom-right

title: Scale mapping

enum: width height symbol category ordinal ramp diverging heatmap

enum: millisecond second minute hour day week month year

description: Discretizing scales

description: Default numeric scale

enum: ordinal band point quantile quantize threshold sequential pow log time utc identity bin-ordinal bin-linear

title: Input event stream definition

enum: row_number rank dense_rank percent_rank cume_dist ntile lag lead first_value last_value nth_value values count missing valid sum mean average variance variancep stdev stdevp stderr distinct ci0 ci1 median q1 q3 argmin argmax min max

enum: squarify resquarify binary dice slice slicedice

default: x y font fontSize fontStyle fontWeight angle

title: FieldRef

title: ColorRef

title: ExpressionRef

title: Expression String

title: Mark Type definition

title: Event Selector String

title: SignalRef

title: Vega 3.0 Visualization Specification Language