schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
sarif-2.1.0.json | text | A plain text message string or format string. | {"type": "string"} |
sarif-2.1.0.json | markdown | A Markdown message string or format string. | {"type": "string"} |
sarif-2.1.0.json | properties | Key/value pairs that provide additional information about the message. | {} |
sarif-2.1.0.json | node | Represents a node in a graph. | {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {}, "location": {}, "children": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}, "required": ["id"]} |
sarif-2.1.0.json | id | A string that uniquely identifies the node within its graph. | {"type": "string"} |
sarif-2.1.0.json | label | A short description of the node. | {} |
sarif-2.1.0.json | location | A code location associated with the node. | {} |
sarif-2.1.0.json | children | Array of child nodes. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-2.1.0.json | properties | Key/value pairs that provide additional information about the node. | {} |
sarif-2.1.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": {"locations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "message": {}, "level": {"default": "warning", "enum": ["none", "note", "warning", "error"]}, "threadId": {"type": "integer"}, "timeUtc": {"type": "string", "format": "date-time"}, "exception": {}, "descriptor": {}, "associatedRule": {}, "properties": {}}, "required": ["message"]} |
sarif-2.1.0.json | locations | The locations relevant to this notification. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-2.1.0.json | message | A message that describes the condition that was encountered. | {} |
sarif-2.1.0.json | level | A value specifying the severity level of the notification. | {"default": "warning", "enum": ["none", "note", "warning", "error"]} |
sarif-2.1.0.json | threadId | The thread identifier of the code that generated the notification. | {"type": "integer"} |
sarif-2.1.0.json | timeUtc | The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification. | {"type": "string", "format": "date-time"} |
sarif-2.1.0.json | exception | The runtime exception, if any, relevant to this notification. | {} |
sarif-2.1.0.json | descriptor | A reference used to locate the descriptor relevant to this notification. | {} |
sarif-2.1.0.json | associatedRule | A reference used to locate the rule descriptor associated with this notification. | {} |
sarif-2.1.0.json | properties | Key/value pairs that provide additional information about the notification. | {} |
sarif-2.1.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": {"address": {}, "artifactLocation": {}, "region": {}, "contextRegion": {}, "properties": {}}, "anyOf": [{"required": ["address"]}, {"required": ["artifactLocation"]}]} |
sarif-2.1.0.json | address | The address of the location. | {} |
sarif-2.1.0.json | artifactLocation | The location of the artifact. | {} |
sarif-2.1.0.json | region | Specifies a portion of the artifact. | {} |
sarif-2.1.0.json | contextRegion | Specifies a portion of the artifact that encloses the region. Allows a viewer to display additional context around the region. | {} |
sarif-2.1.0.json | properties | Key/value pairs that provide additional information about the physical location. | {} |
sarif-2.1.0.json | propertyBag | Key/value pairs that provide additional information about the object. | {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"type": "string"}}}} |
sarif-2.1.0.json | tags | A set of distinct strings that provide additional information. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"type": "string"}} |
sarif-2.1.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": {}, "properties": {}}} |
sarif-2.1.0.json | top | The Y coordinate of the top edge of the rectangle, measured in the image's natural units. | {"type": "number"} |
sarif-2.1.0.json | left | The X coordinate of the left edge of the rectangle, measured in the image's natural units. | {"type": "number"} |
sarif-2.1.0.json | bottom | The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units. | {"type": "number"} |
sarif-2.1.0.json | right | The X coordinate of the right edge of the rectangle, measured in the image's natural units. | {"type": "number"} |
sarif-2.1.0.json | message | A message relevant to the rectangle. | {} |
sarif-2.1.0.json | properties | Key/value pairs that provide additional information about the rectangle. | {} |
sarif-2.1.0.json | region | A region within an artifact 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", "default": -1, "minimum": -1}, "charLength": {"type": "integer", "minimum": 0}, "byteOffset": {"type": "integer", "default": -1, "minimum": -1}, "byteLength": {"type": "integer", "minimum": 0}, "snippet": {}, "message": {}, "sourceLanguage": {"type": "string"}, "properties": {}}} |
sarif-2.1.0.json | startLine | The line number of the first character in the region. | {"type": "integer", "minimum": 1} |
sarif-2.1.0.json | startColumn | The column number of the first character in the region. | {"type": "integer", "minimum": 1} |
sarif-2.1.0.json | endLine | The line number of the last character in the region. | {"type": "integer", "minimum": 1} |
sarif-2.1.0.json | endColumn | The column number of the character following the end of the region. | {"type": "integer", "minimum": 1} |
sarif-2.1.0.json | charOffset | The zero-based offset from the beginning of the artifact of the first character in the region. | {"type": "integer", "default": -1, "minimum": -1} |
sarif-2.1.0.json | charLength | The length of the region in characters. | {"type": "integer", "minimum": 0} |
sarif-2.1.0.json | byteOffset | The zero-based offset from the beginning of the artifact of the first byte in the region. | {"type": "integer", "default": -1, "minimum": -1} |
sarif-2.1.0.json | byteLength | The length of the region in bytes. | {"type": "integer", "minimum": 0} |
sarif-2.1.0.json | snippet | The portion of the artifact contents within the specified region. | {} |
sarif-2.1.0.json | message | A message relevant to the region. | {} |
sarif-2.1.0.json | sourceLanguage | Specifies the source language, if any, of the portion of the artifact specified by the region object. | {"type": "string"} |
sarif-2.1.0.json | properties | Key/value pairs that provide additional information about the region. | {} |
sarif-2.1.0.json | replacement | The replacement of a single region of an artifact. | {"additionalProperties": false, "type": "object", "properties": {"deletedRegion": {}, "insertedContent": {}, "properties": {}}, "required": ["deletedRegion"]} |
sarif-2.1.0.json | deletedRegion | The region of the artifact to delete. | {} |
sarif-2.1.0.json | insertedContent | The content to insert at the location specified by the 'deletedRegion' property. | {} |
sarif-2.1.0.json | properties | Key/value pairs that provide additional information about the replacement. | {} |
sarif-2.1.0.json | reportingDescriptor | Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting. | {"additionalProperties": false, "type": "object", "properties": {"id": {"type": "string"}, "deprecatedIds": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {"type": "string"}}, "guid": {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}, "deprecatedGuids": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}}, "name": {"type": "string"}, "deprecatedNames": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {"type": "string"}}, "shortDescription": {}, "fullDescription": {}, "messageStrings": {"type": "object", "additionalProperties": {}}, "defaultConfiguration": {}, "helpUri": {"type": "string", "format": "uri"}, "help": {}, "relationships": {"type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": {}}, "properties": {}}, "required": ["id"]} |
sarif-2.1.0.json | id | A stable, opaque identifier for the report. | {"type": "string"} |
sarif-2.1.0.json | deprecatedIds | An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool. | {"type": "array", "minItems": 0, "uniqueItems": true, "items": {"type": "string"}} |
sarif-2.1.0.json | guid | A unique identifer for the reporting descriptor in the form of a GUID. | {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"} |
sarif-2.1.0.json | deprecatedGuids | 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. | {"type": "array", "minItems": 0, "uniqueItems": true, "items": {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}} |
sarif-2.1.0.json | name | A report identifier that is understandable to an end user. | {"type": "string"} |
sarif-2.1.0.json | deprecatedNames | An array of readable identifiers by which this report was known in some previous version of the analysis tool. | {"type": "array", "minItems": 0, "uniqueItems": true, "items": {"type": "string"}} |
sarif-2.1.0.json | shortDescription | 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. | {} |
sarif-2.1.0.json | fullDescription | A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result. | {} |
sarif-2.1.0.json | messageStrings | 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. | {"type": "object", "additionalProperties": {}} |
sarif-2.1.0.json | defaultConfiguration | Default reporting configuration information. | {} |
sarif-2.1.0.json | helpUri | A URI where the primary documentation for the report can be found. | {"type": "string", "format": "uri"} |
sarif-2.1.0.json | help | Provides the primary documentation for the report, useful when there is no online documentation. | {} |
sarif-2.1.0.json | relationships | An array of objects that describe relationships between this reporting descriptor and others. | {"type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": {}} |
sarif-2.1.0.json | properties | Key/value pairs that provide additional information about the report. | {} |
sarif-2.1.0.json | reportingConfiguration | Information about a rule or notification that can be configured at runtime. | {"type": "object", "additionalProperties": false, "properties": {"enabled": {"type": "boolean", "default": true}, "level": {"default": "warning", "enum": ["none", "note", "warning", "error"]}, "rank": {"type": "number", "default": -1, "minimum": -1, "maximum": 100}, "parameters": {}, "properties": {}}} |
sarif-2.1.0.json | enabled | Specifies whether the report may be produced during the scan. | {"type": "boolean", "default": true} |
sarif-2.1.0.json | level | Specifies the failure level for the report. | {"default": "warning", "enum": ["none", "note", "warning", "error"]} |
sarif-2.1.0.json | rank | Specifies the relative priority of the report. Used for analysis output only. | {"type": "number", "default": -1, "minimum": -1, "maximum": 100} |
sarif-2.1.0.json | parameters | Contains configuration information specific to a report. | {} |
sarif-2.1.0.json | properties | Key/value pairs that provide additional information about the reporting configuration. | {} |
sarif-2.1.0.json | reportingDescriptorReference | Information about how to locate a relevant reporting descriptor. | {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "index": {"type": "integer", "default": -1, "minimum": -1}, "guid": {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}, "toolComponent": {}, "properties": {}}, "anyOf": [{"required": ["index"]}, {"required": ["guid"]}, {"required": ["id"]}]} |
sarif-2.1.0.json | id | The id of the descriptor. | {"type": "string"} |
sarif-2.1.0.json | index | The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context. | {"type": "integer", "default": -1, "minimum": -1} |
sarif-2.1.0.json | guid | A guid that uniquely identifies the descriptor. | {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"} |
sarif-2.1.0.json | toolComponent | A reference used to locate the toolComponent associated with the descriptor. | {} |
sarif-2.1.0.json | properties | Key/value pairs that provide additional information about the reporting descriptor reference. | {} |
sarif-2.1.0.json | reportingDescriptorRelationship | Information about the relation of one reporting descriptor to another. | {"type": "object", "additionalProperties": false, "properties": {"target": {}, "kinds": {"type": "array", "default": ["relevant"], "uniqueItems": true, "items": {"type": "string"}}, "properties": {}}, "required": ["target"]} |
sarif-2.1.0.json | target | A reference to the related reporting descriptor. | {} |
sarif-2.1.0.json | kinds | A set of distinct strings that categorize the relationship. Well-known kinds include 'canPrecede', 'canFollow', 'willPrecede', 'willFollow', 'superset', 'subset', 'equal', 'disjoint', 'relevant', and 'incomparable'. | {"type": "array", "default": ["relevant"], "uniqueItems": true, "items": {"type": "string"}} |
sarif-2.1.0.json | description | A description of the reporting descriptor relationship. | {} |
sarif-2.1.0.json | properties | Key/value pairs that provide additional information about the reporting descriptor reference. | {} |
sarif-2.1.0.json | result | A result produced by an analysis tool. | {"additionalProperties": false, "type": "object", "properties": {"ruleId": {"type": "string"}, "ruleIndex": {"type": "integer", "default": -1, "minimum": -1}, "rule": {}, "kind": {"default": "fail", "enum": ["notApplicable", "pass", "fail", "review", "open", "informational"]}, "level": {"default": "warning", "enum": ["none", "note", "warning", "error"]}, "message": {}, "analysisTarget": {}, "locations": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "guid": {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}, "correlationGuid": {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"}, "occurrenceCount": {"type": "integer", "minimum": 1}, "partialFingerprints": {"type": "object", "additionalProperties": {"type": "string"}}, "fingerprints": {"type": "object", "additionalProperties": {"type": "string"}}, "stacks": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "codeFlows": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "graphs": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "graphTraversals": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "relatedLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "suppressions": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}, "baselineState": {"enum": ["new", "unchanged", "updated", "absent"]}, "rank": {"type": "number", "default": -1, "minimum": -1, "maximum": 100}, "attachments": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "hostedViewerUri": {"type": "string", "format": "uri"}, "workItemUris": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {"type": "string", "format": "uri"}}, "provenance": {}, "fixes": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "taxa": {"type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": {}}, "webRequest": {}, "webResponse": {}, "properties": {}}, "required": ["message"]} |
sarif-2.1.0.json | ruleId | The stable, unique identifier of the rule, if any, to which this result is relevant. | {"type": "string"} |
sarif-2.1.0.json | ruleIndex | The index within the tool component rules array of the rule object associated with this result. | {"type": "integer", "default": -1, "minimum": -1} |
sarif-2.1.0.json | rule | A reference used to locate the rule descriptor relevant to this result. | {} |
sarif-2.1.0.json | kind | A value that categorizes results by evaluation state. | {"default": "fail", "enum": ["notApplicable", "pass", "fail", "review", "open", "informational"]} |
sarif-2.1.0.json | level | A value specifying the severity level of the result. | {"default": "warning", "enum": ["none", "note", "warning", "error"]} |
sarif-2.1.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.1.0.json | analysisTarget | 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. | {} |
sarif-2.1.0.json | locations | 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. | {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}} |
sarif-2.1.0.json | guid | A stable, unique identifer for the result in the form of a GUID. | {"type": "string", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"} |
sarif-2.1.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", "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"} |
sarif-2.1.0.json | occurrenceCount | A positive integer specifying the number of times this logically unique result was observed in this run. | {"type": "integer", "minimum": 1} |
sarif-2.1.0.json | partialFingerprints | A set of strings that contribute to the stable, unique identity of the result. | {"type": "object", "additionalProperties": {"type": "string"}} |
sarif-2.1.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.1.0.json | stacks | An array of 'stack' objects relevant to the result. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-2.1.0.json | codeFlows | An array of 'codeFlow' objects relevant to the result. | {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}} |
sarif-2.1.0.json | graphs | An array of zero or more unique graph objects associated with the result. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.