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.

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 identifer for this external properties object, in the form of a GUID.

description: A stable, unique identifer 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 identifer 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 identifer 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 identifer 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 identifer 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 identifer 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 identifer 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 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 JSON Schema


travis.json

$ref: #/definitions/job

type: object

type: boolean

type: array

$ref: #/definitions/slackRoom

$ref: #/definitions/notificationObject/slack

$ref: #/definitions/notificationObject/email

$ref: #/definitions/notificationObject/irc

$ref: #/definitions/possiblySecretString

description: If some rows in the build matrix are allowed to fail, the build won't be marked as finished until they have completed. To mark the build as finished as soon as possible, add fast_finish: true

type: string

description: The name of the build stage

default: test

description: The name of the build stage

description: Specifies the order of build stages

description: Specifies a condition for the stage

description: Build config specification version

description: Import YAML config snippets that can be shared across repositories.

$ref: #/definitions/import

$ref: #/definitions/nonEmptyString

$ref: #/definitions/arrayOfNonEmptyStrings

$ref: #/definitions/stringArrayUnique

type: number

$ref: #/definitions/stringOrNumber

description: Your account name, token and optional channel

$ref: #/definitions/secretString

enum: always never change

enum: skip ignore

enum: cassandra couchdb docker elasticsearch mariadb memcached mongodb mysql neo4j postgresql rabbitmq redis redis-server rethinkdb riak xvfb

enum: apt bundler cargo ccache cocoapods packages pip yarn npm

$ref: #/definitions/envVar

enum: android bash c c++ clojure cpp crystal csharp d dart dartlang elixir elm erlang generic go golang groovy haskell haxe java javascript julia jvm matlab minimal nix node node.js node_js nodejs obj-c obj_c objective-c objective_c perl perl6 php python r ruby rust scala sh shell smalltalk

$ref: #/definitions/stringOrStringArrayUnique

description: When the optional solution key is present, Travis will run NuGet package restore and build the given solution.

description: By default, Travis CI will assume that your Podfile is in the root of the repository. If this is not the case, you can specify where the Podfile is

description: A list of packages to install via brew. This option is ignored on non-OS X builds.

description: CRAN mirror to use for fetching packages

description: Dictionary of repositories to pass to options(repos)

description: The CPU Architecture to run the job on

description: The operating system to run the job on

description: The Ubuntu distribution to use

enum: precise trusty xenial bionic focal jammy

description: sudo is deprecated

description: To install packages not included in the default container-based-infrastructure you need to use the APT addon, as sudo apt-get is not available

description: To update the list of available packages

description: Key-value pairs which will be added to /etc/apt/sources.list

description: When APT sources require GPG keys, you can specify this with key_url

description: Alias defined in source whitelist

description: To install packages from the package whitelist before your custom build steps

description: If your build requires setting up custom hostnames, you can specify a single host or a list of them. Travis CI will automatically setup the hostnames in /etc/hosts for both IPv4 and IPv6.

description: Travis CI can add entries to ~/.ssh/known_hosts prior to cloning your git repository, which is necessary if there are git submodules from domains other than github.com, gist.github.com, or ssh.github.com.

description: If you'd like to upload file from a specific directory, you can change your working directory

description: If you'd like to see more detail about what the artifacts addon is doing

description: Firefox addon

enum: latest latest-esr latest-beta latest-dev latest-nightly latest-unsigned

description: Chrome addon

description: RethinkDB addon

description: PostgreSQL addon

description: MariaDB addon

description: Sauce Connect addon

description: SonarCloud addon

description: Coverity Scan addon

description: GitHub project metadata

description: Where email notification of build analysis results will be sent

description: Commands to prepare for build_command

description: The command that will be added as an argument to 'cov-build' to compile your project for analysis

description: Pattern to match selecting branches that will run analysis. We recommend leaving this set to 'coverity_scan'

description: Homebrew addon

description: SourceClear addon

description: Snaps addon

description: 'classic:' is deprecated, use 'confinement:'

description: BrowserStack addon

description: Upload timeout in seconds

description: Set the git clone depth

description: Travis CI clones repositories without the quiet flag (-q) by default. Enabling the quiet flag can be useful if you're trying to avoid log file size limits or even if you just don't need to include it.

description: Control whether submodules should be cloned

description: Skip fetching the git-lfs files during the initial git clone (equivalent to git lfs smudge --skip),

description: In some work flows, like build stages, it might be beneficial to skip the automatic git clone step.

description: Is a path to the existing file in the current repository with data you'd like to put into $GIT_DIR/info/sparse-checkout file of format described in Git documentation.

description: Specify handling of line endings when cloning repository

description: Specify which branches to build

description: Tell Travis CI to only deploy on tagged commits

description: After your tests ran and before the release, Travis CI will clean up any additional files and changes you made. Maybe that is not what you want, as you might generate some artifacts that are supposed to be released, too.

description: if [[ <condition> ]]; then <deploy>; fi

description: If you need to overwrite existing files

description: deploy to heroku, to see https://docs.travis-ci.com/user/deployment/heroku/

description: heroku auth token

description: Deploy master branch to heroku app

description: Deploy the different branch to the different heroku app

description: to run a command on Heroku after a successful deploy

description: Travis CI default will clean up any additional files and changes you made, you can by it to skip the clean up

description: Travis CI supports different mechanisms for deploying to Heroku: api is default

description: The source to import build config from

description: How to merge the imported config into the target config (defaults to deep_merge_append)

description: Specifies a condition for the import

title: JSON schema for Travis CI configuration files


prometheus.rules.test.json

$ref: #/definitions/labels

description: Expanded annotations of the expected alert

description: Expanded labels and annotations of the expected alert. This also include the labels of the sample associated with the alert (same as what you see in `/alerts`, without series `__name__` and `alertname`).

description: Name of the alert to be tested.

$ref: #/definitions/duration

description: The time elapsed from time=0s when the alerts have to be checked.

description: List of expected alerts firing under the given alertname at the given evaluation time

$ref: #/definitions/alert

description: The time elapsed from time=0s when the expression has to be evaluated.

description: Expected samples at the given evaluation time.

$ref: #/definitions/sample

description: PromQL expression to evaluate

description: Labels of the sample in the usual series notation '<metric name>{<label name>=<label value>, ...}'

description: Expected value of the PromQL expression.

required: labels value

description: This follows the usual series notation '<metric name>{<label name>=<label value>, ...}'.

description: This uses expanded notation to project time series. There are also the special `_` and `stale` values to indicate missing or stale samples

required: series values

description: Unit tests for alerting rules. We only consider the alerting rules from the input files.

description: External labels accessible to the alert template.

description: External URL accessible to the alert template. Usually set using --web.external-url.

description: A list of time series

$ref: #/definitions/series

description: Name of the test group

description: Unit tests for PromQL expressions

description: Prometheus rules test file. See https://prometheus.io/docs/prometheus/latest/configuration/unit_testing_rules/ for details.

description: The evaluation interval for the tests. [duration] format.

description: The order in which group names are listed below will be the order of evaluation of rule groups (at a given evaluation time).

description: List of rule files to consider for testing. Globs are supported.

description: All the tests are listed here.

title: Prometheus Rules Test File


megalinter-descriptor.jsonschema.json

description: Command information

examples:
npm run test
echo "This is a custom command"

title: Bash command to run

Description: If command fails, continue MegaLinter process or not

title: Continue if failed

enum: root workspace

examples: root workspace

title: Folder where to run the command

title: Command

enum: all_flavors all ci_light cupcake documentation dotnet dotnetweb go java javascript php python ruby rust salesforce security swift terraform

description: Descriptor definition for MegaLinter

description: Names of the config files to be found (at least one), else descriptor will be deactivated

title: Active if one of file names found

description: MegaLinter flavors matching this descriptor

examples: all_flavors java php

title: Flavors

description: MegaLinter flavors that must not contain this descriptor

title: Flavors

description: Uppercase unique identifier for the language, tooling format or identifier

examples: PYTHON XML OPENAPI

title: Descriptor unique identifier

description: Label for descriptor documentation, if different from Id. Ex: C++ for CPP

examples:
C++
Visual Basic .NET

title: Descriptor label

description: Descriptor type: language, format or tooling format

enum: language format tooling_format other

examples: language format tooling_format other

title: Descriptor type

description: Regular expression list for filtering files by their content

title: File content regex filters

description: If file_contains_regex is set, use this property to filter extensions of the files that will be checked

title: File contain regex extensions filters

description: File extension filters. Empty list excludes all files. Can be overridden at linter level

title: Allowed file extensions

description: List of strings to filter the files according to their end of file name

title: Filter on end of file name

description: Regular expression list for filtering files by their base names using regex full match. Empty list includes all files. Can be overridden at linter level

title: File name regex filters

description: Set when a linter only lints a sub-directory

examples: ansible kubernetes

title: Files sub-directory

$id: #/properties/install

description: List of apk, dockerfile instructions, npm/pip/gem packages required to use the descriptor linters

$id: #/properties/install/properties/apk

description: APK packages identifiers (with or without version)

title: List of APK packages (Linux)

$id: #/properties/install/properties/cargo

description: Cargo packages identifiers (with or without version)

title: List of Cargo packages (Rust)

description: Will be automatically integrated in generated Dockerfile

title: List of Dockerfile instructions packages

$id: #/properties/install/properties/gem

description: GEM packages identifiers (with or without version)

title: List of GEM packages (Ruby)

$id: #/properties/install/properties/npm

description: NPM packages identifiers (with or without version)

title: List of NPM packages (Node.js)

$id: #/properties/install/properties/pip

description: PIP packages identifiers (with or without version)

title: List of PIP packages (Python)

title: Installation requirements

description: If set to true, this descriptor linters will always lint all files, undepending their name/extensions/content

title: Lint all files

description: If set to true, this descriptor linters will lint one by one all files collected by all other linters

title: Lint all other linters files

$id: #/properties/linters

description: List of linter definitions associated to the descriptor

cli_config_extra_args: --no-eslintrc --no-ignore

examples: eslint -c .eslintrc.yml --no-eslintrc --no-ignore myfile.js

npm: eslint eslint-config-airbnb eslint-config-prettier eslint-plugin-jest eslint-plugin-prettier @babel/eslint-parser

linter_name: eslint

linter_name: standard

$id: #/properties/linters/items

description: Parameters defining behaviour and installation of a linter

npm: eslint eslint-config-airbnb eslint-config-prettier eslint-plugin-jest eslint-plugin-prettier babel-eslint

description: List of rules to check to activate linter

default_value: standard

expected_value: prettier

type: variable

title: Activation rules

title: Active if one of file names found

description: Shows if the linter is capable of output SARIF report within MegaLinter

title: Can output SARIF

description: If MegaLinter core is not enough, use a custom class inheriting from Linter class

title: Linter custom python class name

title: CLI configuration file argument name if different from -c

title: Default value for config argument, in case it is not a file

description: When a configuration file is used with the linter CLI, send these additional arguments

examples: --no-eslintrc --no-ignore

title: Additional CLI arguments when config file is used

description: Arguments for docker run before image name

examples: -v `pwd`:`pwd` -w `pwd`

title: CLI docker run arguments

title: Name of the docker image to use for linting

default: latest

description: Version of the docker image to use for linting

title: Docker image version

description: Override if different from linter_name

title: CLI executable for linting request

description: Override if different from cli executable used for linting

title: CLI executable for help request

title: CLI executable for version request

title: CLI Help argument name if different from -h

description: When linter CLI is call for help, send these additional arguments

title: CLI help extra arguments

description: When linter CLI is call for help, send these additional commands

title: CLI help extra commands

description: Defines how to count errors from log file. regex_number, regex_count, regex_sum, or total_lines

title: Lint errors count mode

description: Regex allowing to extract the number of errors from linter output logs

title: Lint errors number regex

description: When linter CLI is call for linting, send these additional arguments before config args

title: CLI Lint extra arguments (before config args)

description: When linter CLI is call for linting, send these additional arguments after config args

title: CLI Lint extra arguments (after config args)

examples: --fix --format

title: If the linter can format or fix, input here the related triggering argument

description: When linter CLI is call for fixing, remove these arguments

title: CLI Lint arguments to remove if fix is activated

description: If the linter can use an ignore file, input here the related argument

examples: --secretlintignore --ignore-path

title: Path to ignore file argument name

description: Defines how the linter is called: file,  list_of_files, project

title: Linting mode

description: Arguments to generate SARIF output

examples: --format sarif --output {{SARIF_OUTPUT_FILE}}

title: CLI SARIF run arguments

title: CLI version argument name if different from -v

description: When linter CLI is call for version, send these additional arguments

title: CLI Version extra arguments

description: An explanation about the purpose of this instance.

title: Default file name for the linter configuration file

description: Shows if the linter is deprecated.

title: Is the linter deprecated?

description: Displays information on why it is deprecated and whether an alternative is available.

title: Description of the deprecated linter

description: MegaLinter flavors matching this linter

title: Flavors

title: Flavors

description: Disable linter in MegaLinter next builds

title: Disabled

description: Explanation about why the linter is downgraded

title: Downgraded reason

description: Indicates that installation instructions does not use the latest release of the linter

title: Downgraded version

description: Please add an example with and without configuration file in the command. They will appear in documentation

examples: golangci-lint run -c .golangci.yml myfile.go

title: Linter CLI commands examples

description: File extension filters if different from the ones defined on parent descriptor

title: Allowed file extensions

title: Filter on end of file name

title: File name regex filters

title: Files sub-directory

title: CLI Help valid return code if different from 0

description: List of IDE supporting the linter

title: IDE Integration

title: Default file name for the linter ignore file

description: If this property is set to true, this linter will be ignored for flavor suggestions

title: Ignore for flavor suggestions

description: List of apk, dockerfile instructions, npm/pip/gem packages required to install the linter

dockerfile: FROM accurics/terrascan:latest as terrascan

dockerfile: COPY --from=terrascan /go/bin/terrascan /usr/bin/

title: List of APK packages (Linux)

title: List of Cargo packages (Rust)

examples: FROM accurics/terrascan:latest as terrascan

examples: COPY --from=terrascan /go/bin/terrascan /usr/bin/

title: List of GEM packages (Ruby)

title: List of NPM packages (Node.js)

title: List of PIP packages (Python)

title: Installation requirements

description: If the linter is just a formatter, set to true so errors will count as warnings

title: Is formatter

description: If the linter is SBOM, set to true so extra properties will be returned

title: Is SBOM

description: If set to true, this linter will always lint all files, undepending their name/extensions/content

title: Lint all files

title: Lint all other linters files

description: URL of an image used to build header of linter Markdown documentation

title: Linter banner image URL

description: If the linter is unable to return help content, hardcode it here

title: Hardcoded help content

description: URL of a PNG image representing the icon of the linter

title: Linter Icon PNG URL

description: URL of an image used in linter Markdown documentation

title: Linter image URL

description: URL to linter documentation referring to MegaLinter

title: MegaLinter reference URL

description: Name of the linter (same as cli command if possible)

title: Linter name

description: URL of the linter repository home page

title: Linter URL

description: URL to linter documentation explaining how to configure the linter

title: Linter rules configuration URL

description: URL to linter documentation explaining how to ignore files

title: Linter rules ignore config URL

description: URL to linter documentation explaining how to disable rules directly with comments in files

title: Linter rules inline disable URL

description: URL to linter documentation listing all the rules that can be detected

title: Linter rules URL

description: spdx license id of the linter

title: spdx license

description: Average speed of the linter (performances indicator). For 1 (very slow) to 5 (very fast)

title: Speed indicator

title: Additional text for MegaLinter online documentation

description: URL of the linter home page

title: Linter URL

description: If the linter is unable to return a version number, hardcode it here

title: Hardcoded version number

description: When several linters in a descriptor, set a different name that will be used for configuration

title: Linter configuration key

description: Custom bash commands to run after linter

command: echo "linter post-run command has been called"

title: Linter Pre-run commands

description: Custom bash commands to run before linter

command: echo "linter pre-run command has been called"

title: Linter Pre-run commands

description: Path to find default SARIF output file when generated by linter

title: SARIF default output file

description: Test folder containing _good_ and _bad_ files, if different from parent descriptor test_folder

title: Test folder in .automation/

description: List of variables to set before running tests

title: Test variables

description: Try to not use this property except if you really have no choice

description: If set to `false`, the `bash-exec` linter will report a warning if a shell script is not executable. If set to `true`, the `bash-exec` linter will report an error instead

title: Custom extra variables for the linter

title: CLI version valid return code if different from 0

description: If default regex to extract version from linter -v call, override it here

title: Regex to extract version

title: Linter definition

title: List of linters

description: If descriptor linters may be slow, put a negative processing order. If it is fast, put a positive one. If you don't know, do not set

title: Descriptor processing order

description: Test folder containing _good_ and _bad_ files. Default: lowercase(descriptor_id)

title: Test folder in .automation/

title: MegaLinter descriptor