schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
sarif-2.1.0-rtm.4.json | stdin | A file containing the standard input stream to the process that was invoked. | {} |
sarif-2.1.0-rtm.4.json | stdout | A file containing the standard output stream from the process that was invoked. | {} |
sarif-2.1.0-rtm.4.json | stderr | A file containing the standard error stream from the process that was invoked. | {} |
sarif-2.1.0-rtm.4.json | stdoutStderr | A file containing the interleaved standard output and standard error stream from the process that was invoked. | {} |
sarif-2.1.0-rtm.4.json | properties | Key/value pairs that provide additional information about the invocation. | {} |
sarif-2.1.0-rtm.4.json | location | A location within a programming artifact. | {"additionalProperties": false, "type": "object", "properties": {"id": {"type": "integer", "minimum": -1, "default": -1}, "physicalLocation": {}, "logicalLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "message": {}, "annotations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "relationships": {"type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": {}}, "properties": {}}} |
sarif-2.1.0-rtm.4.json | id | Value that distinguishes this location from all other locations within a single result object. | {"type": "integer", "minimum": -1, "default": -1} |
sarif-2.1.0-rtm.4.json | physicalLocation | Identifies the artifact and region. | {} |
sarif-2.1.0-rtm.4.json | logicalLocations | The logical locations associated with the result. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-2.1.0-rtm.4.json | message | A message relevant to the location. | {} |
sarif-2.1.0-rtm.4.json | annotations | A set of regions relevant to the location. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-2.1.0-rtm.4.json | relationships | An array of objects that describe relationships between this location and others. | {"type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": {}} |
sarif-2.1.0-rtm.4.json | properties | Key/value pairs that provide additional information about the location. | {} |
sarif-2.1.0-rtm.4.json | locationRelationship | Information about the relation of one location to another. | {"type": "object", "additionalProperties": false, "properties": {"target": {"type": "integer", "minimum": 0}, "kinds": {"type": "array", "default": ["relevant"], "uniqueItems": true, "items": {"type": "string"}}, "properties": {}}, "required": ["target"]} |
sarif-2.1.0-rtm.4.json | target | A reference to the related location. | {"type": "integer", "minimum": 0} |
sarif-2.1.0-rtm.4.json | kinds | A set of distinct strings that categorize the relationship. Well-known kinds include 'includes', 'isIncludedBy' and 'relevant'. | {"type": "array", "default": ["relevant"], "uniqueItems": true, "items": {"type": "string"}} |
sarif-2.1.0-rtm.4.json | description | A description of the location relationship. | {} |
sarif-2.1.0-rtm.4.json | properties | Key/value pairs that provide additional information about the location relationship. | {} |
sarif-2.1.0-rtm.4.json | logicalLocation | A logical location of a construct that produced a result. | {"additionalProperties": false, "type": "object", "properties": {"name": {"type": "string"}, "index": {"type": "integer", "default": -1, "minimum": -1}, "fullyQualifiedName": {"type": "string"}, "decoratedName": {"type": "string"}, "parentIndex": {"type": "integer", "default": -1, "minimum": -1}, "kind": {"type": "string"}, "properties": {}}} |
sarif-2.1.0-rtm.4.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-2.1.0-rtm.4.json | index | The index within the logical locations array. | {"type": "integer", "default": -1, "minimum": -1} |
sarif-2.1.0-rtm.4.json | fullyQualifiedName | The human-readable fully qualified name of the logical location. | {"type": "string"} |
sarif-2.1.0-rtm.4.json | decoratedName | 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. | {"type": "string"} |
sarif-2.1.0-rtm.4.json | parentIndex | 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. | {"type": "integer", "default": -1, "minimum": -1} |
sarif-2.1.0-rtm.4.json | kind | 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. | {"type": "string"} |
sarif-2.1.0-rtm.4.json | properties | Key/value pairs that provide additional information about the logical location. | {} |
sarif-2.1.0-rtm.4.json | message | Encapsulates a message intended to be read by the end user. | {"type": "object", "additionalProperties": false, "properties": {"text": {"type": "string"}, "markdown": {"type": "string"}, "id": {"type": "string"}, "arguments": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {"type": "string"}}, "properties": {}}, "anyOf": [{"required": ["text"]}, {"required": ["id"]}]} |
sarif-2.1.0-rtm.4.json | text | A plain text message string. | {"type": "string"} |
sarif-2.1.0-rtm.4.json | markdown | A Markdown message string. | {"type": "string"} |
sarif-2.1.0-rtm.4.json | id | The identifier for this message. | {"type": "string"} |
sarif-2.1.0-rtm.4.json | arguments | An array of strings to substitute into the message string. | {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {"type": "string"}} |
sarif-2.1.0-rtm.4.json | properties | Key/value pairs that provide additional information about the message. | {} |
sarif-2.1.0-rtm.4.json | multiformatMessageString | A message string or message format string rendered in multiple formats. | {"type": "object", "additionalProperties": false, "properties": {"text": {"type": "string"}, "markdown": {"type": "string"}, "properties": {}}, "required": ["text"]} |
sarif-2.1.0-rtm.4.json | text | A plain text message string or format string. | {"type": "string"} |
sarif-2.1.0-rtm.4.json | markdown | A Markdown message string or format string. | {"type": "string"} |
sarif-2.1.0-rtm.4.json | properties | Key/value pairs that provide additional information about the message. | {} |
sarif-2.1.0-rtm.4.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-rtm.4.json | id | A string that uniquely identifies the node within its graph. | {"type": "string"} |
sarif-2.1.0-rtm.4.json | label | A short description of the node. | {} |
sarif-2.1.0-rtm.4.json | location | A code location associated with the node. | {} |
sarif-2.1.0-rtm.4.json | children | Array of child nodes. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-2.1.0-rtm.4.json | properties | Key/value pairs that provide additional information about the node. | {} |
sarif-2.1.0-rtm.4.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-rtm.4.json | locations | The locations relevant to this notification. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-2.1.0-rtm.4.json | message | A message that describes the condition that was encountered. | {} |
sarif-2.1.0-rtm.4.json | level | A value specifying the severity level of the notification. | {"default": "warning", "enum": ["none", "note", "warning", "error"]} |
sarif-2.1.0-rtm.4.json | threadId | The thread identifier of the code that generated the notification. | {"type": "integer"} |
sarif-2.1.0-rtm.4.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-rtm.4.json | exception | The runtime exception, if any, relevant to this notification. | {} |
sarif-2.1.0-rtm.4.json | descriptor | A reference used to locate the descriptor relevant to this notification. | {} |
sarif-2.1.0-rtm.4.json | associatedRule | A reference used to locate the rule descriptor associated with this notification. | {} |
sarif-2.1.0-rtm.4.json | properties | Key/value pairs that provide additional information about the notification. | {} |
sarif-2.1.0-rtm.4.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-rtm.4.json | address | The address of the location. | {} |
sarif-2.1.0-rtm.4.json | artifactLocation | The location of the artifact. | {} |
sarif-2.1.0-rtm.4.json | region | Specifies a portion of the artifact. | {} |
sarif-2.1.0-rtm.4.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-rtm.4.json | properties | Key/value pairs that provide additional information about the physical location. | {} |
sarif-2.1.0-rtm.4.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-rtm.4.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-rtm.4.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-rtm.4.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-rtm.4.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-rtm.4.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-rtm.4.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-rtm.4.json | message | A message relevant to the rectangle. | {} |
sarif-2.1.0-rtm.4.json | properties | Key/value pairs that provide additional information about the rectangle. | {} |
sarif-2.1.0-rtm.4.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-rtm.4.json | startLine | The line number of the first character in the region. | {"type": "integer", "minimum": 1} |
sarif-2.1.0-rtm.4.json | startColumn | The column number of the first character in the region. | {"type": "integer", "minimum": 1} |
sarif-2.1.0-rtm.4.json | endLine | The line number of the last character in the region. | {"type": "integer", "minimum": 1} |
sarif-2.1.0-rtm.4.json | endColumn | The column number of the character following the end of the region. | {"type": "integer", "minimum": 1} |
sarif-2.1.0-rtm.4.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-rtm.4.json | charLength | The length of the region in characters. | {"type": "integer", "minimum": 0} |
sarif-2.1.0-rtm.4.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-rtm.4.json | byteLength | The length of the region in bytes. | {"type": "integer", "minimum": 0} |
sarif-2.1.0-rtm.4.json | snippet | The portion of the artifact contents within the specified region. | {} |
sarif-2.1.0-rtm.4.json | message | A message relevant to the region. | {} |
sarif-2.1.0-rtm.4.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-rtm.4.json | properties | Key/value pairs that provide additional information about the region. | {} |
sarif-2.1.0-rtm.4.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-rtm.4.json | deletedRegion | The region of the artifact to delete. | {} |
sarif-2.1.0-rtm.4.json | insertedContent | The content to insert at the location specified by the 'deletedRegion' property. | {} |
sarif-2.1.0-rtm.4.json | properties | Key/value pairs that provide additional information about the replacement. | {} |
sarif-2.1.0-rtm.4.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-rtm.4.json | id | A stable, opaque identifier for the report. | {"type": "string"} |
sarif-2.1.0-rtm.4.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-rtm.4.json | guid | A unique identifier 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-rtm.4.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-rtm.4.json | name | A report identifier that is understandable to an end user. | {"type": "string"} |
sarif-2.1.0-rtm.4.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-rtm.4.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-rtm.4.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-rtm.4.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-rtm.4.json | defaultConfiguration | Default reporting configuration information. | {} |
sarif-2.1.0-rtm.4.json | helpUri | A URI where the primary documentation for the report can be found. | {"type": "string", "format": "uri"} |
sarif-2.1.0-rtm.4.json | help | Provides the primary documentation for the report, useful when there is no online documentation. | {} |
sarif-2.1.0-rtm.4.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-rtm.4.json | properties | Key/value pairs that provide additional information about the report. | {} |
sarif-2.1.0-rtm.4.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": {}}} |
Subsets and Splits