schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
sarif-1.0.0.json | threadId | The thread identifier of the code that is executing. | {"type": "integer"} |
sarif-1.0.0.json | message | A message relevant to this annotation. | {"type": "string"} |
sarif-1.0.0.json | kind | Categorizes the location. | {"enum": ["alias", "assignment", "branch", "call", "callReturn", "continuation", "declaration", "functionEnter", "functionExit", "functionReturn", "usage"]} |
sarif-1.0.0.json | taintKind | Classifies state transitions in code locations relevant to a taint analysis. | {"enum": ["source", "sink", "sanitizer"]} |
sarif-1.0.0.json | target | The fully qualified name of the target on which this location operates. For an annotation of kind 'call', for example, the target refers to the fully qualified logical name of the function called from this location. | {"type": "string"} |
sarif-1.0.0.json | values | An ordered set of strings that comprise input or return values for the current operation. For an annotation of kind 'call', for example, this property may hold the ordered list of arguments passed to the callee. | {"type": "array", "default": [], "items": {"type": "string"}} |
sarif-1.0.0.json | state | 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. | {"type": "object"} |
sarif-1.0.0.json | targetKey | A key used to retrieve the target's logicalLocation from the logicalLocations dictionary. | {"type": "string"} |
sarif-1.0.0.json | essential | OBSOLETE (use "importance" instead): True if this location is essential to understanding the code flow in which it occurs. | {"type": "boolean"} |
sarif-1.0.0.json | importance | Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is "essential", "important", "unimportant". Default: "important". | {"enum": ["important", "essential", "unimportant"]} |
sarif-1.0.0.json | snippet | The source code at the specified location. | {"type": "string"} |
sarif-1.0.0.json | annotations | A set of messages relevant to the current annotated code location. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-1.0.0.json | properties | Key/value pairs that provide additional information about the code location. | {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}} |
sarif-1.0.0.json | tags | A set of distinct strings that provide additional information. | {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}} |
sarif-1.0.0.json | message | A message relevant to a code location | {"type": "string"} |
sarif-1.0.0.json | locations | An array of 'physicalLocation' objects associated with the annotation. | {"type": "array", "minItems": 1, "items": {}} |
sarif-1.0.0.json | message | A message relevant to the code flow | {"type": "string"} |
sarif-1.0.0.json | locations | An array of 'annotatedCodeLocation' objects, each of which describes a single location visited by the tool in the course of producing the result. | {"type": "array", "minItems": 1, "items": {}} |
sarif-1.0.0.json | properties | Key/value pairs that provide additional information about the code flow. | {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}} |
sarif-1.0.0.json | tags | A set of distinct strings that provide additional information. | {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}} |
sarif-1.0.0.json | kind | 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. | {"type": "string"} |
sarif-1.0.0.json | message | A string that describes the exception. | {"type": "string"} |
sarif-1.0.0.json | stack | The sequence of function calls leading to the exception. | {} |
sarif-1.0.0.json | innerExceptions | An array of exception objects each of which is considered a cause of this exception. | {"type": "array", "items": {}} |
sarif-1.0.0.json | fileChange | A change to a single file. | {"additionalProperties": false, "type": "object", "properties": {"uri": {"type": "string", "format": "uri"}, "uriBaseId": {"type": "string"}, "replacements": {"type": "array", "minItems": 1, "items": {}}}, "required": ["uri", "replacements"], "dependencies": {"uriBaseId": ["uri"]}} |
sarif-1.0.0.json | uri | A string that represents the location of the file to change as a valid URI. | {"type": "string", "format": "uri"} |
sarif-1.0.0.json | uriBaseId | A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'. | {"type": "string"} |
sarif-1.0.0.json | replacements | An array of replacement objects, each of which represents the replacement of a single range of bytes in a single file specified by 'uri'. | {"type": "array", "minItems": 1, "items": {}} |
sarif-1.0.0.json | file | A single file. In some cases, this file might be nested within another file. | {"additionalProperties": false, "type": "object", "properties": {"uri": {"type": "string", "format": "uri"}, "uriBaseId": {"type": "string"}, "parentKey": {"type": "string"}, "offset": {"type": "integer"}, "length": {"type": "integer"}, "mimeType": {"type": "string", "pattern": "[^/]+/.+"}, "contents": {"type": "string"}, "hashes": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "dependencies": {"uriBaseId": ["uri"]}} |
sarif-1.0.0.json | uri | The path to the file within its containing file. | {"type": "string", "format": "uri"} |
sarif-1.0.0.json | uriBaseId | A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'. | {"type": "string"} |
sarif-1.0.0.json | parentKey | Identifies the key of the immediate parent of the file, if this file is nested. | {"type": "string"} |
sarif-1.0.0.json | offset | The offset in bytes of the file within its containing file. | {"type": "integer"} |
sarif-1.0.0.json | length | The length of the file in bytes. | {"type": "integer"} |
sarif-1.0.0.json | mimeType | The MIME type (RFC 2045) of the file. | {"type": "string", "pattern": "[^/]+/.+"} |
sarif-1.0.0.json | contents | The contents of the file, expressed as a MIME Base64-encoded byte sequence. | {"type": "string"} |
sarif-1.0.0.json | hashes | An array of hash objects, each of which specifies a hashed value for the file, along with the name of the algorithm used to compute the hash. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-1.0.0.json | properties | Key/value pairs that provide additional information about the file. | {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}} |
sarif-1.0.0.json | tags | A set of distinct strings that provide additional information. | {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}} |
sarif-1.0.0.json | fix | A proposed fix for the problem represented by a result object. A fix specifies a set of file to modify. For each file, it specifies a set of bytes to remove, and provides a set of new bytes to replace them. | {"additionalProperties": false, "type": "object", "properties": {"fileChanges": {"type": "array", "items": {}}}, "required": ["description", "fileChanges"]} |
sarif-1.0.0.json | description | A string that describes the proposed fix, enabling viewers to present a proposed change to an end user. | {"type": "string"} |
sarif-1.0.0.json | fileChanges | One or more file changes that comprise a fix for a result. | {"type": "array", "items": {}} |
sarif-1.0.0.json | formattedRuleMessage | Contains information that can be used to construct a formatted message that describes a result. | {"additionalProperties": false, "type": "object", "properties": {"formatId": {"type": "string"}, "arguments": {"type": "array", "items": {"type": "string"}}}, "required": ["formatId"]} |
sarif-1.0.0.json | formatId | A string that identifies the message format used to format the message that describes this result. The value of formatId must correspond to one of the names in the set of name/value pairs contained in the 'messageFormats' property of the rule object whose 'id' property matches the 'ruleId' property of this result. | {"type": "string"} |
sarif-1.0.0.json | arguments | An array of strings that will be used, in combination with a message format, to construct a result message. | {"type": "array", "items": {"type": "string"}} |
sarif-1.0.0.json | hash | A hash value of some file or collection of files, together with the algorithm used to compute the hash. | {"additionalProperties": false, "type": "object", "properties": {"value": {"type": "string"}, "algorithm": {"enum": ["authentihash", "blake256", "blake512", "ecoh", "fsb", "gost", "groestl", "has160", "haval", "jh", "md2", "md4", "md5", "md6", "radioGatun", "ripeMD", "ripeMD128", "ripeMD160", "ripeMD320", "sdhash", "sha1", "sha224", "sha256", "sha384", "sha512", "sha3", "skein", "snefru", "spectralHash", "ssdeep", "swifft", "tiger", "tlsh", "whirlpool"]}}, "required": ["value", "algorithm"]} |
sarif-1.0.0.json | value | The hash value of some file or collection of files, computed by the algorithm named in the 'algorithm' property. | {"type": "string"} |
sarif-1.0.0.json | algorithm | The name of the algorithm used to compute the hash value specified in the 'value' property. | {"enum": ["authentihash", "blake256", "blake512", "ecoh", "fsb", "gost", "groestl", "has160", "haval", "jh", "md2", "md4", "md5", "md6", "radioGatun", "ripeMD", "ripeMD128", "ripeMD160", "ripeMD320", "sdhash", "sha1", "sha224", "sha256", "sha384", "sha512", "sha3", "skein", "snefru", "spectralHash", "ssdeep", "swifft", "tiger", "tlsh", "whirlpool"]} |
sarif-1.0.0.json | invocation | The runtime environment of the analysis tool run. | {"additionalProperties": false, "type": "object", "properties": {"commandLine": {"type": "string"}, "responseFiles": {"type": "object", "additionalProperties": true}, "startTime": {"type": "string", "format": "date-time"}, "endTime": {"type": "string", "format": "date-time"}, "machine": {"type": "string"}, "account": {"type": "string"}, "processId": {"type": "integer"}, "fileName": {"type": "string"}, "workingDirectory": {"type": "string"}, "environmentVariables": {"type": "object", "additionalProperties": true, "default": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}} |
sarif-1.0.0.json | commandLine | The command line used to invoke the tool. | {"type": "string"} |
sarif-1.0.0.json | responseFiles | The contents of any response files specified on the tool's command line. | {"type": "object", "additionalProperties": true} |
sarif-1.0.0.json | startTime | The date and time at which the run started. See "Date/time properties" in the SARIF spec for the required format. | {"type": "string", "format": "date-time"} |
sarif-1.0.0.json | endTime | The date and time at which the run ended. See "Date/time properties" in the SARIF spec for the required format. | {"type": "string", "format": "date-time"} |
sarif-1.0.0.json | machine | The machine that hosted the analysis tool run. | {"type": "string"} |
sarif-1.0.0.json | account | The account that ran the analysis tool. | {"type": "string"} |
sarif-1.0.0.json | processId | The process id for the analysis tool run. | {"type": "integer"} |
sarif-1.0.0.json | fileName | The fully qualified path to the analysis tool. | {"type": "string"} |
sarif-1.0.0.json | workingDirectory | The working directory for the analysis rool run. | {"type": "string"} |
sarif-1.0.0.json | environmentVariables | The environment variables associated with the analysis tool process, expressed as key/value pairs. | {"type": "object", "additionalProperties": true, "default": {}} |
sarif-1.0.0.json | properties | Key/value pairs that provide additional information about the run. | {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}} |
sarif-1.0.0.json | tags | A set of distinct strings that provide additional information. | {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}} |
sarif-1.0.0.json | location | The location where an analysis tool produced a result. | {"additionalProperties": false, "type": "object", "properties": {"analysisTarget": {}, "resultFile": {}, "fullyQualifiedLogicalName": {"type": "string"}, "logicalLocationKey": {"type": "string"}, "decoratedName": {"type": "string"}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}} |
sarif-1.0.0.json | analysisTarget | Identifies the file that the analysis tool was instructed to scan. This need not be the same as the file where the result actually occurred. | {} |
sarif-1.0.0.json | resultFile | Identifies the file where the analysis tool produced the result. | {} |
sarif-1.0.0.json | fullyQualifiedLogicalName | The human-readable fully qualified name of the logical location where the analysis tool produced the result. If 'logicalLocationKey' is not specified, this member is can used to retrieve the location logicalLocation from the logicalLocations dictionary, if one exists. | {"type": "string"} |
sarif-1.0.0.json | logicalLocationKey | A key used to retrieve the location logicalLocation from the logicalLocations dictionary, when the string specified by 'fullyQualifiedLogicalName' is not unique. | {"type": "string"} |
sarif-1.0.0.json | decoratedName | The machine-readable fully qualified name for the logical location where the analysis tool produced the result, such as the mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name. | {"type": "string"} |
sarif-1.0.0.json | properties | Key/value pairs that provide additional information about the location. | {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}} |
sarif-1.0.0.json | tags | A set of distinct strings that provide additional information. | {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}} |
sarif-1.0.0.json | logicalLocation | A logical location of a construct that produced a result. | {"additionalProperties": false, "type": "object", "properties": {"name": {"type": "string"}, "parentKey": {"type": "string"}, "kind": {"type": "string"}}} |
sarif-1.0.0.json | name | Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method. | {"type": "string"} |
sarif-1.0.0.json | parentKey | Identifies the key of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type. | {"type": "string"} |
sarif-1.0.0.json | kind | The type of construct this logicalLocationComponent refers to. Should be one of 'function', 'member', 'module', 'namespace', 'package', 'resource', or 'type', if any of those accurately describe the construct. | {"type": "string"} |
sarif-1.0.0.json | notification | Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool. | {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "ruleId": {"type": "string"}, "ruleKey": {"type": "string"}, "physicalLocation": {}, "message": {"type": "string"}, "level": {"default": "warning", "enum": ["note", "warning", "error"]}, "threadId": {"type": "integer"}, "time": {"type": "string", "format": "date-time"}, "exception": {}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["message"]} |
sarif-1.0.0.json | id | An identifier for the condition that was encountered. | {"type": "string"} |
sarif-1.0.0.json | ruleId | The stable, unique identifier of the rule (if any) to which this notification is relevant. If 'ruleKey' is not specified, this member can be used to retrieve rule metadata from the rules dictionary, if it exists. | {"type": "string"} |
sarif-1.0.0.json | ruleKey | A key used to retrieve the rule metadata from the rules dictionary that is relevant to the notification. | {"type": "string"} |
sarif-1.0.0.json | physicalLocation | The file and region relevant to this notification. | {} |
sarif-1.0.0.json | message | A string that describes the condition that was encountered. | {"type": "string"} |
sarif-1.0.0.json | level | A value specifying the severity level of the notification. | {"default": "warning", "enum": ["note", "warning", "error"]} |
sarif-1.0.0.json | threadId | The thread identifier of the code that generated the notification. | {"type": "integer"} |
sarif-1.0.0.json | time | The date and time at which the analysis tool generated the notification. | {"type": "string", "format": "date-time"} |
sarif-1.0.0.json | exception | The runtime exception, if any, relevant to this notification. | {} |
sarif-1.0.0.json | properties | Key/value pairs that provide additional information about the notification. | {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}} |
sarif-1.0.0.json | tags | A set of distinct strings that provide additional information. | {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}} |
sarif-1.0.0.json | physicalLocation | 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. | {"additionalProperties": false, "type": "object", "properties": {"uri": {"type": "string", "format": "uri"}, "uriBaseId": {"type": "string"}, "region": {}}, "dependencies": {"uriBaseId": ["uri"]}} |
sarif-1.0.0.json | uri | The location of the file as a valid URI. | {"type": "string", "format": "uri"} |
sarif-1.0.0.json | uriBaseId | A string that identifies the conceptual base for the 'uri' property (if it is relative), e.g.,'$(SolutionDir)' or '%SRCROOT%'. | {"type": "string"} |
sarif-1.0.0.json | region | The region within the file where the result was detected. | {} |
sarif-1.0.0.json | region | A region within a file where a result was detected. | {"additionalProperties": false, "type": "object", "properties": {"startLine": {"type": "integer", "minimum": 1}, "startColumn": {"type": "integer", "minimum": 1}, "endLine": {"type": "integer", "minimum": 1}, "endColumn": {"type": "integer", "minimum": 1}, "offset": {"type": "integer", "minimum": 0}, "length": {"type": "integer", "minimum": 0}}} |
sarif-1.0.0.json | startLine | The line number of the first character in the region. | {"type": "integer", "minimum": 1} |
sarif-1.0.0.json | startColumn | The column number of the first character in the region. | {"type": "integer", "minimum": 1} |
sarif-1.0.0.json | endLine | The line number of the last character in the region. | {"type": "integer", "minimum": 1} |
sarif-1.0.0.json | endColumn | The column number of the last character in the region. | {"type": "integer", "minimum": 1} |
sarif-1.0.0.json | offset | The zero-based offset from the beginning of the file of the first byte or character in the region. | {"type": "integer", "minimum": 0} |
sarif-1.0.0.json | length | The length of the region in bytes or characters. | {"type": "integer", "minimum": 0} |
sarif-1.0.0.json | replacement | The replacement of a single range of bytes in a file. Specifies the location within the file where the replacement is to be made, the number of bytes to remove at that location, and a sequence of bytes to insert at that location. | {"additionalProperties": false, "type": "object", "properties": {"offset": {"type": "integer", "minimum": 0}, "deletedLength": {"type": "integer", "minimum": 1}, "insertedBytes": {"type": "string"}}, "required": ["offset"]} |
sarif-1.0.0.json | offset | A non-negative integer specifying the offset in bytes from the beginning of the file at which bytes are to be removed, inserted or both. An offset of 0 shall denote the first byte in the file. | {"type": "integer", "minimum": 0} |
sarif-1.0.0.json | deletedLength | The number of bytes to delete, starting at the byte offset specified by offset, measured from the beginning of the file. | {"type": "integer", "minimum": 1} |
sarif-1.0.0.json | insertedBytes | The MIME Base64-encoded byte sequence to be inserted at the byte offset specified by the 'offset' property, measured from the beginning of the file. | {"type": "string"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.