schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
sarif-2.0.0.json | region | Specifies a portion of the file. | {} |
sarif-2.0.0.json | contextRegion | Specifies a portion of the file that encloses the region. Allows a viewer to display additional context around the region. | {} |
sarif-2.0.0.json | rectangle | An area within an image. | {"additionalProperties": false, "type": "object", "properties": {"top": {"type": "number"}, "left": {"type": "number"}, "bottom": {"type": "number"}, "right": {"type": "number"}, "message": {}}} |
sarif-2.0.0.json | top | The Y coordinate of the top edge of the rectangle, measured in the image's natural units. | {"type": "number"} |
sarif-2.0.0.json | left | The X coordinate of the left edge of the rectangle, measured in the image's natural units. | {"type": "number"} |
sarif-2.0.0.json | bottom | The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units. | {"type": "number"} |
sarif-2.0.0.json | right | The X coordinate of the right edge of the rectangle, measured in the image's natural units. | {"type": "number"} |
sarif-2.0.0.json | message | A message relevant to the rectangle. | {} |
sarif-2.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}, "charOffset": {"type": "integer", "minimum": 0}, "charLength": {"type": "integer", "minimum": 0}, "byteOffset": {"type": "integer", "minimum": 0}, "byteLength": {"type": "integer", "minimum": 0}, "snippet": {}, "message": {}}} |
sarif-2.0.0.json | startLine | The line number of the first character in the region. | {"type": "integer", "minimum": 1} |
sarif-2.0.0.json | startColumn | The column number of the first character in the region. | {"type": "integer", "minimum": 1} |
sarif-2.0.0.json | endLine | The line number of the last character in the region. | {"type": "integer", "minimum": 1} |
sarif-2.0.0.json | endColumn | The column number of the character following the end of the region. | {"type": "integer", "minimum": 1} |
sarif-2.0.0.json | charOffset | The zero-based offset from the beginning of the file of the first character in the region. | {"type": "integer", "minimum": 0} |
sarif-2.0.0.json | charLength | The length of the region in characters. | {"type": "integer", "minimum": 0} |
sarif-2.0.0.json | byteOffset | The zero-based offset from the beginning of the file of the first byte in the region. | {"type": "integer", "minimum": 0} |
sarif-2.0.0.json | byteLength | The length of the region in bytes. | {"type": "integer", "minimum": 0} |
sarif-2.0.0.json | snippet | The portion of the file contents within the specified region. | {} |
sarif-2.0.0.json | message | A message relevant to the region. | {} |
sarif-2.0.0.json | replacement | The replacement of a single region of a file. | {"additionalProperties": false, "type": "object", "properties": {"deletedRegion": {}, "insertedContent": {}}, "required": ["deletedRegion"]} |
sarif-2.0.0.json | deletedRegion | The region of the file to delete. | {} |
sarif-2.0.0.json | insertedContent | The content to insert at the location specified by the 'deletedRegion' property. | {} |
sarif-2.0.0.json | resources | Container for items that require localization. | {"type": "object", "properties": {"messageStrings": {"type": "object", "additionalProperties": {"type": "string"}}, "rules": {"type": "object", "additionalProperties": {}}}} |
sarif-2.0.0.json | messageStrings | A dictionary, each of whose keys is a resource identifier and each of whose values is a localized string. | {"type": "object", "additionalProperties": {"type": "string"}} |
sarif-2.0.0.json | rules | A dictionary, each of whose keys is a string and each of whose values is a 'rule' object, that describe all rules associated with an analysis tool or a specific run of an analysis tool. | {"type": "object", "additionalProperties": {}} |
sarif-2.0.0.json | result | A result produced by an analysis tool. | {"additionalProperties": false, "type": "object", "properties": {"ruleId": {"type": "string"}, "level": {"enum": ["notApplicable", "pass", "note", "warning", "error", "open"]}, "message": {}, "analysisTarget": {}, "locations": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "instanceGuid": {"type": "string"}, "correlationGuid": {"type": "string"}, "partialFingerprints": {"type": "object", "additionalProperties": {"type": "string"}}, "fingerprints": {"type": "object", "additionalProperties": {"type": "string"}}, "stacks": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "codeFlows": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "graphs": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "graphTraversals": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "relatedLocations": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "suppressionStates": {"type": "array", "items": {"enum": ["suppressedInSource", "suppressedExternally"]}}, "baselineState": {"enum": ["new", "existing", "absent"]}, "attachments": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "workItemUris": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "string", "format": "uri"}}, "conversionProvenance": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "fixes": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}} |
sarif-2.0.0.json | ruleId | The stable, unique identifier of the rule (if any) to which this notification is relevant. This member can be used to retrieve rule metadata from the rules dictionary, if it exists. | {"type": "string"} |
sarif-2.0.0.json | level | A value specifying the severity level of the result. | {"enum": ["notApplicable", "pass", "note", "warning", "error", "open"]} |
sarif-2.0.0.json | message | A message that describes the result. The first sentence of the message only will be displayed when visible space is limited. | {} |
sarif-2.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-2.0.0.json | locations | One or more locations where the result occurred. Specify only one location unless the problem indicated by the result can only be corrected by making a change at every specified location. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-2.0.0.json | instanceGuid | A stable, unique identifier for the result in the form of a GUID. | {"type": "string"} |
sarif-2.0.0.json | correlationGuid | A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID. | {"type": "string"} |
sarif-2.0.0.json | partialFingerprints | A set of strings that contribute to the stable, unique identity of the result. | {"type": "object", "additionalProperties": {"type": "string"}} |
sarif-2.0.0.json | fingerprints | A set of strings each of which individually defines a stable, unique identity for the result. | {"type": "object", "additionalProperties": {"type": "string"}} |
sarif-2.0.0.json | stacks | An array of 'stack' objects relevant to the result. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-2.0.0.json | codeFlows | An array of 'codeFlow' objects relevant to the result. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-2.0.0.json | graphs | An array of one or more unique 'graph' objects. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-2.0.0.json | graphTraversals | An array of one or more unique 'graphTraversal' objects. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-2.0.0.json | relatedLocations | A set of locations relevant to this result. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-2.0.0.json | suppressionStates | A set of flags indicating one or more suppression conditions. | {"type": "array", "items": {"enum": ["suppressedInSource", "suppressedExternally"]}} |
sarif-2.0.0.json | baselineState | The state of a result relative to a baseline of a previous run. | {"enum": ["new", "existing", "absent"]} |
sarif-2.0.0.json | attachments | A set of files relevant to the result. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-2.0.0.json | workItemUris | The URIs of the work items associated with this result | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {"type": "string", "format": "uri"}} |
sarif-2.0.0.json | conversionProvenance | An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result object. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-2.0.0.json | fixes | An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-2.0.0.json | properties | Key/value pairs that provide additional information about the result. | {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}} |
sarif-2.0.0.json | tags | A set of distinct strings that provide additional information. | {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}} |
sarif-2.0.0.json | rule | Describes an analysis rule. | {"additionalProperties": false, "type": "object", "properties": {"id": {"type": "string"}, "name": {}, "shortDescription": {}, "fullDescription": {}, "messageStrings": {"type": "object", "additionalProperties": {"type": "string"}}, "richMessageStrings": {"type": "object", "additionalProperties": {"type": "string"}}, "configuration": {}, "helpUri": {"type": "string", "format": "uri"}, "help": {}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["id"]} |
sarif-2.0.0.json | id | A stable, opaque identifier for the rule. | {"type": "string"} |
sarif-2.0.0.json | name | A rule identifier that is understandable to an end user. | {} |
sarif-2.0.0.json | shortDescription | A concise description of the rule. Should be a single sentence that is understandable when visible space is limited to a single line of text. | {} |
sarif-2.0.0.json | fullDescription | A description of the rule. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result. | {} |
sarif-2.0.0.json | messageStrings | A set of name/value pairs with arbitrary names. The value within each name/value pair consists of plain text interspersed with placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments. | {"type": "object", "additionalProperties": {"type": "string"}} |
sarif-2.0.0.json | richMessageStrings | A set of name/value pairs with arbitrary names. The value within each name/value pair consists of rich text interspersed with placeholders, which can be used to construct a message in combination with an arbitrary number of additional string arguments. | {"type": "object", "additionalProperties": {"type": "string"}} |
sarif-2.0.0.json | configuration | Information about the rule that can be configured at runtime. | {} |
sarif-2.0.0.json | helpUri | A URI where the primary documentation for the rule can be found. | {"type": "string", "format": "uri"} |
sarif-2.0.0.json | help | Provides the primary documentation for the rule, useful when there is no online documentation. | {} |
sarif-2.0.0.json | properties | Key/value pairs that provide additional information about the rule. | {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}} |
sarif-2.0.0.json | tags | A set of distinct strings that provide additional information. | {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}} |
sarif-2.0.0.json | ruleConfiguration | Information about a rule that can be configured at runtime. | {"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean"}, "defaultLevel": {"default": "warning", "enum": ["note", "warning", "error", "open"]}, "parameters": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}} |
sarif-2.0.0.json | enabled | Specifies whether the rule will be evaluated during the scan. | {"type": "boolean"} |
sarif-2.0.0.json | defaultLevel | Specifies the default severity level of the result. | {"default": "warning", "enum": ["note", "warning", "error", "open"]} |
sarif-2.0.0.json | parameters | Contains configuration information specific to this rule. | {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}} |
sarif-2.0.0.json | tags | A set of distinct strings that provide additional configuration information. | {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}} |
sarif-2.0.0.json | run | Describes a single run of an analysis tool, and contains the output of that run. | {"additionalProperties": false, "type": "object", "properties": {"tool": {}, "invocations": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "conversion": {}, "versionControlProvenance": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "originalUriBaseIds": {"type": "object", "additionalProperties": {"type": "string", "format": "uri"}}, "files": {"type": "object", "additionalProperties": {}}, "logicalLocations": {"type": "object", "additionalProperties": {}}, "graphs": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "results": {"type": "array", "minItems": 0, "items": {}}, "resources": {}, "instanceGuid": {"type": "string"}, "correlationGuid": {"type": "string"}, "logicalId": {"type": "string"}, "automationLogicalId": {"type": "string"}, "baselineInstanceGuid": {"type": "string"}, "architecture": {"type": "string"}, "richMessageMimeType": {"type": "string", "default": "text/markdown;variant=GFM"}, "redactionToken": {"type": "string"}, "defaultFileEncoding": {"type": "string"}, "columnKind": {"enum": ["utf16CodeUnits", "unicodeCodePoints"]}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["tool"]} |
sarif-2.0.0.json | tool | 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. | {} |
sarif-2.0.0.json | invocations | Describes the invocation of the analysis tool. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-2.0.0.json | conversion | A conversion object that describes how a converter transformed an analysis tool's native output format into the SARIF format. | {} |
sarif-2.0.0.json | versionControlProvenance | Specifies the revision in version control of the files that were scanned. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-2.0.0.json | originalUriBaseIds | The absolute URI specified by each uriBaseId symbol on the machine where the tool originally ran. | {"type": "object", "additionalProperties": {"type": "string", "format": "uri"}} |
sarif-2.0.0.json | files | A dictionary, each of whose keys is a URI and each of whose values is a file object. | {"type": "object", "additionalProperties": {}} |
sarif-2.0.0.json | logicalLocations | A dictionary, each of whose keys specifies a logical location such as a namespace, type or function. | {"type": "object", "additionalProperties": {}} |
sarif-2.0.0.json | graphs | An array of one or more unique 'graph' objects. | {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}} |
sarif-2.0.0.json | results | 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. | {"type": "array", "minItems": 0, "items": {}} |
sarif-2.0.0.json | resources | Items that can be localized, such as message strings and rule metadata. | {} |
sarif-2.0.0.json | instanceGuid | A stable, unique identifier for the run, in the form of a GUID. | {"type": "string"} |
sarif-2.0.0.json | correlationGuid | A stable, unique identifier for the class of related runs to which this run belongs, in the form of a GUID. | {"type": "string"} |
sarif-2.0.0.json | logicalId | A logical identifier for a run, for example, 'nightly Clang analyzer run'. Multiple runs of the same type can have the same logical id. | {"type": "string"} |
sarif-2.0.0.json | description | A description of the run. | {} |
sarif-2.0.0.json | automationLogicalId | A global identifier that allows the run to be correlated with other artifacts produced by a larger automation process. | {"type": "string"} |
sarif-2.0.0.json | baselineInstanceGuid | The 'instanceGuid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run. | {"type": "string"} |
sarif-2.0.0.json | architecture | The hardware architecture for which the run was targeted. | {"type": "string"} |
sarif-2.0.0.json | richMessageMimeType | The MIME type of all rich text message properties in the run. Default: "text/markdown;variant=GFM" | {"type": "string", "default": "text/markdown;variant=GFM"} |
sarif-2.0.0.json | redactionToken | The string used to replace sensitive information in a redaction-aware property. | {"type": "string"} |
sarif-2.0.0.json | defaultFileEncoding | Specifies the default encoding for any file object that refers to a text file. | {"type": "string"} |
sarif-2.0.0.json | columnKind | Specifies the unit in which the tool measures columns. | {"enum": ["utf16CodeUnits", "unicodeCodePoints"]} |
sarif-2.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-2.0.0.json | tags | A set of distinct strings that provide additional information about the run. | {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}} |
sarif-2.0.0.json | stack | A call stack that is relevant to a result. | {"additionalProperties": false, "type": "object", "properties": {"message": {}, "frames": {"type": "array", "minItems": 1, "items": {}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}, "required": ["frames"]} |
sarif-2.0.0.json | message | A message relevant to this call stack. | {} |
sarif-2.0.0.json | frames | An array of stack frames that represent a sequence of calls, rendered in reverse chronological order, that comprise the call stack. | {"type": "array", "minItems": 1, "items": {}} |
sarif-2.0.0.json | properties | Key/value pairs that provide additional information about the stack. | {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}} |
sarif-2.0.0.json | tags | A set of distinct strings that provide additional information. | {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}} |
sarif-2.0.0.json | stackFrame | A function call within a stack trace. | {"additionalProperties": false, "type": "object", "properties": {"location": {}, "module": {"type": "string"}, "threadId": {"type": "integer"}, "address": {"type": "integer"}, "offset": {"type": "integer"}, "parameters": {"type": "array", "items": {"type": "string", "default": []}}, "properties": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "uniqueItems": true, "default": [], "items": {"type": "string"}}}}}} |
sarif-2.0.0.json | location | The location to which this stack frame refers. | {} |
sarif-2.0.0.json | module | The name of the module that contains the code of this stack frame. | {"type": "string"} |
sarif-2.0.0.json | threadId | The thread identifier of the stack frame. | {"type": "integer"} |
sarif-2.0.0.json | address | The address of the method or function that is executing. | {"type": "integer"} |
sarif-2.0.0.json | offset | The offset from the method or function that is executing. | {"type": "integer"} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.