schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
catalog-info.json | email | An email where this user can be reached. | {"type": "string", "examples": ["[email protected]"], "minLength": 1} |
catalog-info.json | picture | The URL of an image that represents this user. | {"type": "string", "examples": ["https://example.com/staff/jenny-with-party-hat.jpeg"], "minLength": 1} |
catalog-info.json | memberOf | The list of groups that the user is a direct member of (i.e., no transitive memberships are listed here). The list must be present, but may be empty if the user is not member of any groups. The items are not guaranteed to be ordered in any particular way. The entries of this array are entity references. | {"type": "array", "items": {"type": "string", "examples": ["team-b", "employees"], "minLength": 1}} |
catalog-info.json | entity | The parts of the format that's common to all versions/kinds of entity. | {"$schema": "http://json-schema.org/draft-07/schema#", "examples": [{"apiVersion": "backstage.io/v1alpha1", "kind": "Component", "metadata": {"name": "LoremService", "labels": {"product_name": "Random value Generator"}, "annotations": {"docs": "https://github.com/..../tree/develop/doc"}}, "spec": {"type": "service", "lifecycle": "production", "owner": "tools"}}], "type": "object", "required": ["apiVersion", "kind", "metadata"], "additionalProperties": false, "properties": {"apiVersion": {"type": "string", "minLength": 1, "examples": ["backstage.io/v1alpha1", "my-company.net/v1", "1.0"]}, "kind": {"type": "string", "minLength": 1, "examples": ["API", "Component", "Domain", "Group", "Location", "Resource", "System", "Template", "User"]}, "metadata": {"$schema": "http://json-schema.org/draft-07/schema#", "examples": [{"uid": "e01199ab-08cc-44c2-8e19-5c29ded82521", "etag": "lsndfkjsndfkjnsdfkjnsd==", "generation": 13, "name": "my-component-yay", "namespace": "the-namespace", "labels": {"backstage.io/custom": "ValueStuff"}, "annotations": {"example.com/bindings": "are-secret"}, "tags": ["java", "data"]}], "type": "object", "required": ["name"], "additionalProperties": true, "properties": {"uid": {"type": "string", "examples": ["e01199ab-08cc-44c2-8e19-5c29ded82521"], "minLength": 1}, "etag": {"type": "string", "examples": ["lsndfkjsndfkjnsdfkjnsd=="], "minLength": 1}, "generation": {"type": "integer", "examples": [1], "minimum": 1}, "name": {"type": "string", "examples": ["metadata-proxy"], "minLength": 1}, "namespace": {"type": "string", "default": "default", "examples": ["default", "admin"], "minLength": 1}, "labels": {"type": "object", "additionalProperties": true, "patternProperties": {"^.+$": {"type": "string"}}}, "annotations": {"type": "object", "additionalProperties": true, "patternProperties": {"^.+$": {"type": "string"}}}, "tags": {"type": "array", "items": {"type": "string", "minLength": 1}}, "links": {"type": "array", "items": {"type": "object", "required": ["url"], "properties": {"url": {"type": "string", "examples": ["https://admin.example-org.com"], "minLength": 1}, "icon": {"type": "string", "examples": ["dashboard"], "minLength": 1}}}}}}, "spec": {"type": "object"}, "relations": {"type": "array", "items": {}}, "status": {}}} |
catalog-info.json | metadata | Creates Lorems like a pro. | {"name": "LoremService", "labels": {"product_name": "Random value Generator"}, "annotations": {"docs": "https://github.com/..../tree/develop/doc"}} |
catalog-info.json | apiVersion | The version of specification format for this particular entity that this is written against. | {"type": "string", "minLength": 1, "examples": ["backstage.io/v1alpha1", "my-company.net/v1", "1.0"]} |
catalog-info.json | kind | The high level entity type being described. | {"type": "string", "minLength": 1, "examples": ["API", "Component", "Domain", "Group", "Location", "Resource", "System", "Template", "User"]} |
catalog-info.json | metadata | Metadata fields common to all versions/kinds of entity. | {"$schema": "http://json-schema.org/draft-07/schema#", "examples": [{"uid": "e01199ab-08cc-44c2-8e19-5c29ded82521", "etag": "lsndfkjsndfkjnsdfkjnsd==", "generation": 13, "name": "my-component-yay", "namespace": "the-namespace", "labels": {"backstage.io/custom": "ValueStuff"}, "annotations": {"example.com/bindings": "are-secret"}, "tags": ["java", "data"]}], "type": "object", "required": ["name"], "additionalProperties": true, "properties": {"uid": {"type": "string", "examples": ["e01199ab-08cc-44c2-8e19-5c29ded82521"], "minLength": 1}, "etag": {"type": "string", "examples": ["lsndfkjsndfkjnsdfkjnsd=="], "minLength": 1}, "generation": {"type": "integer", "examples": [1], "minimum": 1}, "name": {"type": "string", "examples": ["metadata-proxy"], "minLength": 1}, "namespace": {"type": "string", "default": "default", "examples": ["default", "admin"], "minLength": 1}, "labels": {"type": "object", "additionalProperties": true, "patternProperties": {"^.+$": {"type": "string"}}}, "annotations": {"type": "object", "additionalProperties": true, "patternProperties": {"^.+$": {"type": "string"}}}, "tags": {"type": "array", "items": {"type": "string", "minLength": 1}}, "links": {"type": "array", "items": {"type": "object", "required": ["url"], "properties": {"url": {"type": "string", "examples": ["https://admin.example-org.com"], "minLength": 1}, "icon": {"type": "string", "examples": ["dashboard"], "minLength": 1}}}}}} |
catalog-info.json | uid | A globally unique ID for the entity. This field can not be set by the user at creation time, and the server will reject an attempt to do so. The field will be populated in read operations. The field can (optionally) be specified when performing update or delete operations, but the server is free to reject requests that do so in such a way that it breaks semantics. | {"type": "string", "examples": ["e01199ab-08cc-44c2-8e19-5c29ded82521"], "minLength": 1} |
catalog-info.json | etag | An opaque string that changes for each update operation to any part of the entity, including metadata. This field can not be set by the user at creation time, and the server will reject an attempt to do so. The field will be populated in read operations. The field can (optionally) be specified when performing update or delete operations, and the server will then reject the operation if it does not match the current stored value. | {"type": "string", "examples": ["lsndfkjsndfkjnsdfkjnsd=="], "minLength": 1} |
catalog-info.json | generation | A positive nonzero number that indicates the current generation of data for this entity; the value is incremented each time the spec changes. This field can not be set by the user at creation time, and the server will reject an attempt to do so. The field will be populated in read operations. | {"type": "integer", "examples": [1], "minimum": 1} |
catalog-info.json | name | The name of the entity. Must be unique within the catalog at any given point in time, for any given namespace + kind pair. | {"type": "string", "examples": ["metadata-proxy"], "minLength": 1} |
catalog-info.json | namespace | The namespace that the entity belongs to. | {"type": "string", "default": "default", "examples": ["default", "admin"], "minLength": 1} |
catalog-info.json | title | A display name of the entity, to be presented in user interfaces instead of the name property, when available. | {"type": "string", "examples": ["React SSR Template"], "minLength": 1} |
catalog-info.json | description | A short (typically relatively few words, on one line) description of the entity. | {"type": "string"} |
catalog-info.json | labels | Key/value pairs of identifying information attached to the entity. | {"type": "object", "additionalProperties": true, "patternProperties": {"^.+$": {"type": "string"}}} |
catalog-info.json | annotations | Key/value pairs of non-identifying auxiliary information attached to the entity. | {"type": "object", "additionalProperties": true, "patternProperties": {"^.+$": {"type": "string"}}} |
catalog-info.json | tags | A list of single-valued strings, to for example classify catalog entities in various ways. | {"type": "array", "items": {"type": "string", "minLength": 1}} |
catalog-info.json | links | A list of external hyperlinks related to the entity. Links can provide additional contextual information that may be located outside of Backstage itself. For example, an admin dashboard or external CMS page. | {"type": "array", "items": {"type": "object", "required": ["url"], "properties": {"url": {"type": "string", "examples": ["https://admin.example-org.com"], "minLength": 1}, "icon": {"type": "string", "examples": ["dashboard"], "minLength": 1}}}} |
catalog-info.json | url | A url in a standard uri format. | {"type": "string", "examples": ["https://admin.example-org.com"], "minLength": 1} |
catalog-info.json | title | A user friendly display name for the link. | {"type": "string", "examples": ["Admin Dashboard"], "minLength": 1} |
catalog-info.json | icon | A key representing a visual icon to be displayed in the UI. | {"type": "string", "examples": ["dashboard"], "minLength": 1} |
catalog-info.json | spec | The specification data describing the entity itself. | {"type": "object"} |
catalog-info.json | relations | The relations that this entity has with other entities. | {"type": "array", "items": {}} |
catalog-info.json | common | Common definitions to import from other schemas | {"$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "definitions": {"reference": {"type": "object", "required": ["kind", "namespace", "name"], "additionalProperties": false, "properties": {"kind": {"type": "string", "minLength": 1}, "namespace": {"type": "string", "minLength": 1}, "name": {"type": "string", "minLength": 1}}}, "relation": {"type": "object", "required": ["type", "target"], "additionalProperties": false, "properties": {"type": {"type": "string", "minLength": 1, "pattern": "^\\w+$"}, "target": {}}}, "status": {"type": "object", "required": [], "additionalProperties": true, "properties": {"items": {"type": "array", "items": {}}}}, "statusItem": {"type": "object", "required": ["type", "level", "message"], "additionalProperties": true, "properties": {"type": {"type": "string", "minLength": 1}, "level": {}, "message": {"type": "string"}, "error": {}}}, "statusLevel": {"type": "string", "enum": ["info", "warning", "error"]}, "error": {"type": "object", "required": ["name", "message"], "additionalProperties": true, "properties": {"name": {"type": "string", "examples": ["Error", "InputError"], "minLength": 1}, "message": {"type": "string"}, "code": {"type": "string"}, "stack": {"type": "string"}}}}} |
catalog-info.json | reference | A reference by name to another entity. | {"type": "object", "required": ["kind", "namespace", "name"], "additionalProperties": false, "properties": {"kind": {"type": "string", "minLength": 1}, "namespace": {"type": "string", "minLength": 1}, "name": {"type": "string", "minLength": 1}}} |
catalog-info.json | kind | The kind field of the entity. | {"type": "string", "minLength": 1} |
catalog-info.json | namespace | The metadata.namespace field of the entity. | {"type": "string", "minLength": 1} |
catalog-info.json | name | The metadata.name field of the entity. | {"type": "string", "minLength": 1} |
catalog-info.json | relation | A directed relation from one entity to another. | {"type": "object", "required": ["type", "target"], "additionalProperties": false, "properties": {"type": {"type": "string", "minLength": 1, "pattern": "^\\w+$"}, "target": {}}} |
catalog-info.json | type | The type of relation. | {"type": "string", "minLength": 1, "pattern": "^\\w+$"} |
catalog-info.json | status | The current status of the entity, as claimed by various sources. | {"type": "object", "required": [], "additionalProperties": true, "properties": {"items": {"type": "array", "items": {}}}} |
catalog-info.json | statusItem | A specific status item on a well known format. | {"type": "object", "required": ["type", "level", "message"], "additionalProperties": true, "properties": {"type": {"type": "string", "minLength": 1}, "level": {}, "message": {"type": "string"}, "error": {}}} |
catalog-info.json | level | The status level / severity of the status item. | {} |
catalog-info.json | message | A brief message describing the status, intended for human consumption. | {"type": "string"} |
catalog-info.json | error | An optional serialized error object related to the status. | {} |
catalog-info.json | statusLevel | A status level / severity. | {"type": "string", "enum": ["info", "warning", "error"]} |
catalog-info.json | error | A serialized error object. | {"type": "object", "required": ["name", "message"], "additionalProperties": true, "properties": {"name": {"type": "string", "examples": ["Error", "InputError"], "minLength": 1}, "message": {"type": "string"}, "code": {"type": "string"}, "stack": {"type": "string"}}} |
catalog-info.json | name | The type name of the error | {"type": "string", "examples": ["Error", "InputError"], "minLength": 1} |
catalog-info.json | message | The message of the error | {"type": "string"} |
catalog-info.json | code | An error code associated with the error | {"type": "string"} |
catalog-info.json | stack | An error stack trace | {"type": "string"} |
nuget-project.json | dependencies | A list of dependencies. | {"type": "object", "additionalProperties": {"type": ["string", "object"], "properties": {"version": {"type": "string"}, "type": {"type": "string", "default": "default", "enum": ["default", "build"]}}}} |
nuget-project.json | frameworks | The frameworks on which your project will run. | {"type": "object", "additionalProperties": {}} |
nuget-project.json | runtimes | The Operating System and Architectures on which your application will be running. | {"type": "object", "properties": {"centos.7-x64": {"type": "object"}, "debian.8-x64": {"type": "object"}, "fedora.23-x64": {"type": "object"}, "fedora.24-x64": {"type": "object"}, "linuxmint.17-x64": {"type": "object"}, "linuxmint.17.1-x64": {"type": "object"}, "linuxmint.17.2-x64": {"type": "object"}, "linuxmint.17.3-x64": {"type": "object"}, "linuxmint.18-x64": {"type": "object"}, "ol.7.0-x64": {"type": "object"}, "ol.7.1-x64": {"type": "object"}, "ol.7.2-x64": {"type": "object"}, "opensuse.13.2-x64": {"type": "object"}, "opensuse.42.1-x64": {"type": "object"}, "osx.10.10-x64": {"type": "object"}, "osx.10.11-x64": {"type": "object"}, "osx.10.12-x64": {"type": "object"}, "rhel.7.0-x64": {"type": "object"}, "rhel.7.1-x64": {"type": "object"}, "rhel.7.2-x64": {"type": "object"}, "ubuntu.14.04-x64": {"type": "object"}, "ubuntu.14.10-x64": {"type": "object"}, "ubuntu.15.04-x64": {"type": "object"}, "ubuntu.15.10-x64": {"type": "object"}, "ubuntu.16.04-x64": {"type": "object"}, "ubuntu.16.10-x64": {"type": "object"}, "win": {"type": "object"}, "win-x86": {"type": "object"}, "win-x64": {"type": "object"}, "win7": {"type": "object"}, "win7-x86": {"type": "object"}, "win7-x64": {"type": "object"}, "win8": {"type": "object"}, "win8-x86": {"type": "object"}, "win8-x64": {"type": "object"}, "win8-arm": {"type": "object"}, "win81": {"type": "object"}, "win81-x86": {"type": "object"}, "win81-x64": {"type": "object"}, "win81-arm": {"type": "object"}, "win10-arm": {"type": "object"}, "win10-arm-aot": {"type": "object"}, "win10-x86": {"type": "object"}, "win10-x86-aot": {"type": "object"}, "win10-x64": {"type": "object"}, "win10-x64-aot": {"type": "object"}}} |
nuget-project.json | supports | A list of supported target frameworks. | {"type": "object", "additionalProperties": {"type": "object"}} |
nuget-project.json | additionalProperties | A supported target framework. | {"type": "object"} |
sarif-2.1.0-rtm.5.json | Static Analysis Results Format (SARIF) Version 2.1.0-rtm.5 JSON Schema: a standard format for the output of static analysis tools. | {"$schema": "http://json-schema.org/draft-07/schema#", "additionalProperties": false, "definitions": {"address": {"additionalProperties": false, "type": "object", "properties": {"absoluteAddress": {"type": "integer", "minimum": -1, "default": -1}, "relativeAddress": {"type": "integer"}, "length": {"type": "integer"}, "kind": {"type": "string"}, "name": {"type": "string"}, "fullyQualifiedName": {"type": "string"}, "offsetFromParent": {"type": "integer"}, "index": {"type": "integer", "default": -1, "minimum": -1}, "parentIndex": {"type": "integer", "default": -1, "minimum": -1}, "properties": {}}}, "artifact": {"additionalProperties": false, "type": "object", "properties": {"location": {}, "parentIndex": {"type": "integer", "default": -1, "minimum": -1}, "offset": {"type": "integer", "minimum": 0}, "length": {"type": "integer", "default": -1, "minimum": -1}, "roles": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"enum": ["analysisTarget", "attachment", "responseFile", "resultFile", "standardStream", "tracedFile", "unmodified", "modified", "added", "deleted", "renamed", "uncontrolled", "driver", "extension", "translation", "taxonomy", "policy", "referencedOnCommandLine", "memoryContents", "directory", "userSpecifiedConfiguration", "toolSpecifiedConfiguration", "debugOutputFile"]}}, "mimeType": {"type": "string", "pattern": "[^/]+/.+"}, "contents": {}, "encoding": {"type": "string"}, "sourceLanguage": {"type": "string"}, "hashes": {"type": "object", "additionalProperties": {"type": "string"}}, "lastModifiedTimeUtc": {"type": "string", "format": "date-time"}, "properties": {}}}, "artifactChange": {"additionalProperties": false, "type": "object", "properties": {"artifactLocation": {}, "replacements": {"type": "array", "minItems": 1, "uniqueItems": false, "items": {}}, "properties": {}}, "required": ["artifactLocation", "replacements"]}, "artifactContent": {"type": "object", "additionalProperties": false, "properties": {"text": {"type": "string"}, "binary": {"type": "string"}, "rendered": {}, "properties": {}}}, "artifactLocation": {"additionalProperties": false, "type": "object", "properties": {"uri": {"type": "string", "format": "uri-reference"}, "uriBaseId": {"type": "string"}, "index": {"type": "integer", "default": -1, "minimum": -1}, "properties": {}}}, "attachment": {"type": "object", "additionalProperties": false, "properties": {"artifactLocation": {}, "regions": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "rectangles": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}, "required": ["artifactLocation"]}, "codeFlow": {"additionalProperties": false, "type": "object", "properties": {"message": {}, "threadFlows": {"type": "array", "minItems": 1, "uniqueItems": false, "items": {}}, "properties": {}}, "required": ["threadFlows"]}, "configurationOverride": {"type": "object", "additionalProperties": false, "properties": {"configuration": {}, "descriptor": {}, "properties": {}}, "required": ["configuration", "descriptor"]}, "conversion": {"additionalProperties": false, "type": "object", "properties": {"tool": {}, "invocation": {}, "analysisToolLogFiles": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}, "required": ["tool"]}, "edge": {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {}, "sourceNodeId": {"type": "string"}, "targetNodeId": {"type": "string"}, "properties": {}}, "required": ["id", "sourceNodeId", "targetNodeId"]}, "edgeTraversal": {"type": "object", "additionalProperties": false, "properties": {"edgeId": {"type": "string"}, "message": {}, "finalState": {"type": "object", "additionalProperties": {}}, "stepOverEdgeCount": {"type": "integer", "minimum": 0}, "properties": {}}, "required": ["edgeId"]}, "exception": {"type": "object", "additionalProperties": false, "properties": {"kind": {"type": "string"}, "message": {"type": "string"}, "stack": {}, "innerExceptions": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "properties": {}}}, "externalProperties": {"type": "object", "additionalProperties": false, "properties": {"schema": {"type": "string", "format": "uri"}, "version": {"enum": ["2.1.0"]}, "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}$"}, "runGuid": {"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}$"}, "conversion": {}, "graphs": {"type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": {}}, "externalizedProperties": {}, "artifacts": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}, "invocations": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "logicalLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "threadFlowLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "results": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "taxonomies": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "driver": {}, "extensions": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "policies": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "translations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "addresses": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "webRequests": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "webResponses": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}}, "externalPropertyFileReference": {"type": "object", "additionalProperties": false, "properties": {"location": {}, "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}$"}, "itemCount": {"type": "integer", "default": -1, "minimum": -1}, "properties": {}}, "anyOf": [{"required": ["location"]}, {"required": ["guid"]}]}, "externalPropertyFileReferences": {"additionalProperties": false, "type": "object", "properties": {"conversion": {}, "graphs": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "externalizedProperties": {}, "artifacts": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "invocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "logicalLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "threadFlowLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "results": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "taxonomies": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "addresses": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "driver": {}, "extensions": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "policies": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "translations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "webRequests": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "webResponses": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}}, "fix": {"additionalProperties": false, "type": "object", "properties": {"artifactChanges": {"type": "array", "minItems": 1, "uniqueItems": true, "items": {}}, "properties": {}}, "required": ["artifactChanges"]}, "graph": {"type": "object", "additionalProperties": false, "properties": {"nodes": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "edges": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}}, "graphTraversal": {"type": "object", "additionalProperties": false, "properties": {"runGraphIndex": {"type": "integer", "default": -1, "minimum": -1}, "resultGraphIndex": {"type": "integer", "default": -1, "minimum": -1}, "initialState": {"type": "object", "additionalProperties": {}}, "immutableState": {"type": "object", "additionalProperties": {}}, "edgeTraversals": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "properties": {}}, "oneOf": [{"required": ["runGraphIndex"]}, {"required": ["resultGraphIndex"]}]}, "invocation": {"additionalProperties": false, "type": "object", "properties": {"commandLine": {"type": "string"}, "arguments": {"type": "array", "minItems": 0, "uniqueItems": false, "items": {"type": "string"}}, "responseFiles": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}, "startTimeUtc": {"type": "string", "format": "date-time"}, "endTimeUtc": {"type": "string", "format": "date-time"}, "exitCode": {"type": "integer"}, "ruleConfigurationOverrides": {"type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": {}}, "notificationConfigurationOverrides": {"type": "array", "minItems": 0, "default": [], "uniqueItems": true, "items": {}}, "toolExecutionNotifications": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "toolConfigurationNotifications": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "exitCodeDescription": {"type": "string"}, "exitSignalName": {"type": "string"}, "exitSignalNumber": {"type": "integer"}, "processStartFailureMessage": {"type": "string"}, "executionSuccessful": {"type": "boolean"}, "machine": {"type": "string"}, "account": {"type": "string"}, "processId": {"type": "integer"}, "executableLocation": {}, "workingDirectory": {}, "environmentVariables": {"type": "object", "additionalProperties": {"type": "string"}}, "stdin": {}, "stdout": {}, "stderr": {}, "stdoutStderr": {}, "properties": {}}, "required": ["executionSuccessful"]}, "location": {"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": {}}}, "locationRelationship": {"type": "object", "additionalProperties": false, "properties": {"target": {"type": "integer", "minimum": 0}, "kinds": {"type": "array", "default": ["relevant"], "uniqueItems": true, "items": {"type": "string"}}, "properties": {}}, "required": ["target"]}, "logicalLocation": {"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": {}}}, "message": {"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"]}]}, "multiformatMessageString": {"type": "object", "additionalProperties": false, "properties": {"text": {"type": "string"}, "markdown": {"type": "string"}, "properties": {}}, "required": ["text"]}, "node": {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "label": {}, "location": {}, "children": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}, "required": ["id"]}, "notification": {"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"]}, "physicalLocation": {"additionalProperties": false, "type": "object", "properties": {"address": {}, "artifactLocation": {}, "region": {}, "contextRegion": {}, "properties": {}}, "anyOf": [{"required": ["address"]}, {"required": ["artifactLocation"]}]}, "propertyBag": {"type": "object", "additionalProperties": true, "properties": {"tags": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"type": "string"}}}}, "rectangle": {"additionalProperties": false, "type": "object", "properties": {"top": {"type": "number"}, "left": {"type": "number"}, "bottom": {"type": "number"}, "right": {"type": "number"}, "message": {}, "properties": {}}}, "region": {"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": {}}}, "replacement": {"additionalProperties": false, "type": "object", "properties": {"deletedRegion": {}, "insertedContent": {}, "properties": {}}, "required": ["deletedRegion"]}, "reportingDescriptor": {"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"]}, "reportingConfiguration": {"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": {}}}, "reportingDescriptorReference": {"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"]}]}, "reportingDescriptorRelationship": {"type": "object", "additionalProperties": false, "properties": {"target": {}, "kinds": {"type": "array", "default": ["relevant"], "uniqueItems": true, "items": {"type": "string"}}, "properties": {}}, "required": ["target"]}, "result": {"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"]}, "resultProvenance": {"additionalProperties": false, "type": "object", "properties": {"firstDetectionTimeUtc": {"type": "string", "format": "date-time"}, "lastDetectionTimeUtc": {"type": "string", "format": "date-time"}, "firstDetectionRunGuid": {"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}$"}, "lastDetectionRunGuid": {"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}$"}, "invocationIndex": {"type": "integer", "default": -1, "minimum": -1}, "conversionSources": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}}, "run": {"additionalProperties": false, "type": "object", "properties": {"tool": {}, "invocations": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "conversion": {}, "language": {"type": "string", "default": "en-US", "pattern": "^[a-zA-Z]{2}|^[a-zA-Z]{2}-[a-zA-Z]{2}?$"}, "versionControlProvenance": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "originalUriBaseIds": {"type": "object", "additionalProperties": {}}, "artifacts": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}, "logicalLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "graphs": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "results": {"type": "array", "minItems": 0, "uniqueItems": false, "items": {}}, "automationDetails": {}, "runAggregates": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "baselineGuid": {"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}$"}, "redactionTokens": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"type": "string"}}, "defaultEncoding": {"type": "string"}, "defaultSourceLanguage": {"type": "string"}, "newlineSequences": {"type": "array", "minItems": 1, "uniqueItems": true, "default": ["\r\n", "\n"], "items": {"type": "string"}}, "columnKind": {"enum": ["utf16CodeUnits", "unicodeCodePoints"]}, "externalPropertyFileReferences": {}, "threadFlowLocations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "taxonomies": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "addresses": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {}}, "translations": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "policies": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "webRequests": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "webResponses": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "specialLocations": {}, "properties": {}}, "required": ["tool"]}, "runAutomationDetails": {"additionalProperties": false, "type": "object", "properties": {"id": {"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}$"}, "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}$"}, "properties": {}}}, "specialLocations": {"type": "object", "additionalProperties": false, "properties": {"displayBase": {}, "properties": {}}}, "stack": {"additionalProperties": false, "type": "object", "properties": {"message": {}, "frames": {"type": "array", "minItems": 0, "uniqueItems": false, "items": {}}, "properties": {}}, "required": ["frames"]}, "stackFrame": {"additionalProperties": false, "type": "object", "properties": {"location": {}, "module": {"type": "string"}, "threadId": {"type": "integer"}, "parameters": {"type": "array", "minItems": 0, "uniqueItems": false, "default": [], "items": {"type": "string", "default": []}}, "properties": {}}}, "suppression": {"additionalProperties": false, "type": "object", "properties": {"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}$"}, "kind": {"enum": ["inSource", "external"]}, "status": {"enum": ["accepted", "underReview", "rejected"]}, "justification": {"type": "string"}, "location": {}, "properties": {}}, "required": ["kind"]}, "threadFlow": {"type": "object", "additionalProperties": false, "properties": {"id": {"type": "string"}, "message": {}, "initialState": {"type": "object", "additionalProperties": {}}, "immutableState": {"type": "object", "additionalProperties": {}}, "locations": {"type": "array", "minItems": 1, "uniqueItems": false, "items": {}}, "properties": {}}, "required": ["locations"]}, "threadFlowLocation": {"additionalProperties": false, "type": "object", "properties": {"index": {"type": "integer", "default": -1, "minimum": -1}, "location": {}, "stack": {}, "kinds": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"type": "string"}}, "taxa": {"type": "array", "default": [], "minItems": 0, "uniqueItems": true, "items": {}}, "module": {"type": "string"}, "state": {"type": "object", "additionalProperties": {}}, "nestingLevel": {"type": "integer", "minimum": 0}, "executionOrder": {"type": "integer", "default": -1, "minimum": -1}, "executionTimeUtc": {"type": "string", "format": "date-time"}, "importance": {"enum": ["important", "essential", "unimportant"], "default": "important"}, "webRequest": {}, "webResponse": {}, "properties": {}}}, "tool": {"additionalProperties": false, "type": "object", "properties": {"driver": {}, "extensions": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}, "required": ["driver"]}, "toolComponent": {"additionalProperties": false, "type": "object", "properties": {"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}$"}, "name": {"type": "string"}, "organization": {"type": "string"}, "product": {"type": "string"}, "productSuite": {"type": "string"}, "shortDescription": {}, "fullDescription": {}, "fullName": {"type": "string"}, "version": {"type": "string"}, "semanticVersion": {"type": "string"}, "dottedQuadFileVersion": {"type": "string", "pattern": "[0-9]+(\\.[0-9]+){3}"}, "releaseDateUtc": {"type": "string"}, "downloadUri": {"type": "string", "format": "uri"}, "informationUri": {"type": "string", "format": "uri"}, "globalMessageStrings": {"type": "object", "additionalProperties": {}}, "notifications": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "rules": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "taxa": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "locations": {"type": "array", "minItems": 0, "default": [], "items": {}}, "language": {"type": "string", "default": "en-US", "pattern": "^[a-zA-Z]{2}|^[a-zA-Z]{2}-[a-zA-Z]{2}?$"}, "contents": {"type": "array", "uniqueItems": true, "default": ["localizedData", "nonLocalizedData"], "items": {"enum": ["localizedData", "nonLocalizedData"]}}, "isComprehensive": {"type": "boolean", "default": false}, "localizedDataSemanticVersion": {"type": "string"}, "minimumRequiredLocalizedDataSemanticVersion": {"type": "string"}, "associatedComponent": {}, "translationMetadata": {}, "supportedTaxonomies": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}, "required": ["name"]}, "toolComponentReference": {"type": "object", "additionalProperties": false, "properties": {"name": {"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}$"}, "properties": {}}}, "translationMetadata": {"type": "object", "additionalProperties": false, "properties": {"name": {"type": "string"}, "fullName": {"type": "string"}, "shortDescription": {}, "fullDescription": {}, "downloadUri": {"type": "string", "format": "uri"}, "informationUri": {"type": "string", "format": "uri"}, "properties": {}}, "required": ["name"]}, "versionControlDetails": {"type": "object", "additionalProperties": false, "properties": {"repositoryUri": {"type": "string", "format": "uri"}, "revisionId": {"type": "string"}, "branch": {"type": "string"}, "revisionTag": {"type": "string"}, "asOfTimeUtc": {"type": "string", "format": "date-time"}, "mappedTo": {}, "properties": {}}, "required": ["repositoryUri"]}, "webRequest": {"type": "object", "additionalProperties": false, "properties": {"index": {"type": "integer", "default": -1, "minimum": -1}, "protocol": {"type": "string"}, "version": {"type": "string"}, "target": {"type": "string"}, "method": {"type": "string"}, "headers": {"type": "object", "additionalProperties": {"type": "string"}}, "parameters": {"type": "object", "additionalProperties": {"type": "string"}}, "body": {}, "properties": {}}}, "webResponse": {"type": "object", "additionalProperties": false, "properties": {"index": {"type": "integer", "default": -1, "minimum": -1}, "protocol": {"type": "string"}, "version": {"type": "string"}, "statusCode": {"type": "integer"}, "reasonPhrase": {"type": "string"}, "headers": {"type": "object", "additionalProperties": {"type": "string"}}, "body": {}, "noResponseReceived": {"type": "boolean", "default": false}, "properties": {}}}}, "properties": {"$schema": {"type": "string", "format": "uri"}, "version": {"enum": ["2.1.0"]}, "runs": {"type": "array", "minItems": 0, "uniqueItems": false, "items": {}}, "inlineExternalProperties": {"type": "array", "minItems": 0, "uniqueItems": true, "items": {}}, "properties": {}}, "required": ["version", "runs"], "type": "object"} |
|
sarif-2.1.0-rtm.5.json | address | A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file). | {"additionalProperties": false, "type": "object", "properties": {"absoluteAddress": {"type": "integer", "minimum": -1, "default": -1}, "relativeAddress": {"type": "integer"}, "length": {"type": "integer"}, "kind": {"type": "string"}, "name": {"type": "string"}, "fullyQualifiedName": {"type": "string"}, "offsetFromParent": {"type": "integer"}, "index": {"type": "integer", "default": -1, "minimum": -1}, "parentIndex": {"type": "integer", "default": -1, "minimum": -1}, "properties": {}}} |
sarif-2.1.0-rtm.5.json | absoluteAddress | The address expressed as a byte offset from the start of the addressable region. | {"type": "integer", "minimum": -1, "default": -1} |
sarif-2.1.0-rtm.5.json | relativeAddress | The address expressed as a byte offset from the absolute address of the top-most parent object. | {"type": "integer"} |
sarif-2.1.0-rtm.5.json | length | The number of bytes in this range of addresses. | {"type": "integer"} |
sarif-2.1.0-rtm.5.json | kind | An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values. | {"type": "string"} |
sarif-2.1.0-rtm.5.json | name | A name that is associated with the address, e.g., '.text'. | {"type": "string"} |
sarif-2.1.0-rtm.5.json | fullyQualifiedName | A human-readable fully qualified name that is associated with the address. | {"type": "string"} |
sarif-2.1.0-rtm.5.json | offsetFromParent | The byte offset of this address from the absolute or relative address of the parent object. | {"type": "integer"} |
sarif-2.1.0-rtm.5.json | index | The index within run.addresses of the cached object for this address. | {"type": "integer", "default": -1, "minimum": -1} |
sarif-2.1.0-rtm.5.json | parentIndex | The index within run.addresses of the parent object. | {"type": "integer", "default": -1, "minimum": -1} |
sarif-2.1.0-rtm.5.json | properties | Key/value pairs that provide additional information about the address. | {} |
sarif-2.1.0-rtm.5.json | artifact | A single artifact. In some cases, this artifact might be nested within another artifact. | {"additionalProperties": false, "type": "object", "properties": {"location": {}, "parentIndex": {"type": "integer", "default": -1, "minimum": -1}, "offset": {"type": "integer", "minimum": 0}, "length": {"type": "integer", "default": -1, "minimum": -1}, "roles": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"enum": ["analysisTarget", "attachment", "responseFile", "resultFile", "standardStream", "tracedFile", "unmodified", "modified", "added", "deleted", "renamed", "uncontrolled", "driver", "extension", "translation", "taxonomy", "policy", "referencedOnCommandLine", "memoryContents", "directory", "userSpecifiedConfiguration", "toolSpecifiedConfiguration", "debugOutputFile"]}}, "mimeType": {"type": "string", "pattern": "[^/]+/.+"}, "contents": {}, "encoding": {"type": "string"}, "sourceLanguage": {"type": "string"}, "hashes": {"type": "object", "additionalProperties": {"type": "string"}}, "lastModifiedTimeUtc": {"type": "string", "format": "date-time"}, "properties": {}}} |
sarif-2.1.0-rtm.5.json | description | A short description of the artifact. | {} |
sarif-2.1.0-rtm.5.json | location | The location of the artifact. | {} |
sarif-2.1.0-rtm.5.json | parentIndex | Identifies the index of the immediate parent of the artifact, if this artifact is nested. | {"type": "integer", "default": -1, "minimum": -1} |
sarif-2.1.0-rtm.5.json | offset | The offset in bytes of the artifact within its containing artifact. | {"type": "integer", "minimum": 0} |
sarif-2.1.0-rtm.5.json | length | The length of the artifact in bytes. | {"type": "integer", "default": -1, "minimum": -1} |
sarif-2.1.0-rtm.5.json | roles | The role or roles played by the artifact in the analysis. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {"enum": ["analysisTarget", "attachment", "responseFile", "resultFile", "standardStream", "tracedFile", "unmodified", "modified", "added", "deleted", "renamed", "uncontrolled", "driver", "extension", "translation", "taxonomy", "policy", "referencedOnCommandLine", "memoryContents", "directory", "userSpecifiedConfiguration", "toolSpecifiedConfiguration", "debugOutputFile"]}} |
sarif-2.1.0-rtm.5.json | mimeType | The MIME type (RFC 2045) of the artifact. | {"type": "string", "pattern": "[^/]+/.+"} |
sarif-2.1.0-rtm.5.json | contents | The contents of the artifact. | {} |
sarif-2.1.0-rtm.5.json | encoding | Specifies the encoding for an artifact object that refers to a text file. | {"type": "string"} |
sarif-2.1.0-rtm.5.json | sourceLanguage | Specifies the source language for any artifact object that refers to a text file that contains source code. | {"type": "string"} |
sarif-2.1.0-rtm.5.json | hashes | 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. | {"type": "object", "additionalProperties": {"type": "string"}} |
sarif-2.1.0-rtm.5.json | lastModifiedTimeUtc | 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. | {"type": "string", "format": "date-time"} |
sarif-2.1.0-rtm.5.json | properties | Key/value pairs that provide additional information about the artifact. | {} |
sarif-2.1.0-rtm.5.json | artifactChange | A change to a single artifact. | {"additionalProperties": false, "type": "object", "properties": {"artifactLocation": {}, "replacements": {"type": "array", "minItems": 1, "uniqueItems": false, "items": {}}, "properties": {}}, "required": ["artifactLocation", "replacements"]} |
sarif-2.1.0-rtm.5.json | artifactLocation | The location of the artifact to change. | {} |
sarif-2.1.0-rtm.5.json | replacements | An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'. | {"type": "array", "minItems": 1, "uniqueItems": false, "items": {}} |
sarif-2.1.0-rtm.5.json | properties | Key/value pairs that provide additional information about the change. | {} |
sarif-2.1.0-rtm.5.json | artifactContent | Represents the contents of an artifact. | {"type": "object", "additionalProperties": false, "properties": {"text": {"type": "string"}, "binary": {"type": "string"}, "rendered": {}, "properties": {}}} |
sarif-2.1.0-rtm.5.json | text | UTF-8-encoded content from a text artifact. | {"type": "string"} |
sarif-2.1.0-rtm.5.json | binary | MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding. | {"type": "string"} |
sarif-2.1.0-rtm.5.json | rendered | An alternate rendered representation of the artifact (e.g., a decompiled representation of a binary region). | {} |
sarif-2.1.0-rtm.5.json | properties | Key/value pairs that provide additional information about the artifact content. | {} |
sarif-2.1.0-rtm.5.json | artifactLocation | Specifies the location of an artifact. | {"additionalProperties": false, "type": "object", "properties": {"uri": {"type": "string", "format": "uri-reference"}, "uriBaseId": {"type": "string"}, "index": {"type": "integer", "default": -1, "minimum": -1}, "properties": {}}} |
sarif-2.1.0-rtm.5.json | uri | A string containing a valid relative or absolute URI. | {"type": "string", "format": "uri-reference"} |
sarif-2.1.0-rtm.5.json | uriBaseId | A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted. | {"type": "string"} |
sarif-2.1.0-rtm.5.json | index | The index within the run artifacts array of the artifact object associated with the artifact location. | {"type": "integer", "default": -1, "minimum": -1} |
sarif-2.1.0-rtm.5.json | description | A short description of the artifact location. | {} |
sarif-2.1.0-rtm.5.json | properties | Key/value pairs that provide additional information about the artifact location. | {} |
sarif-2.1.0-rtm.5.json | attachment | An artifact relevant to a result. | {"type": "object", "additionalProperties": false, "properties": {"artifactLocation": {}, "regions": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "rectangles": {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}}, "properties": {}}, "required": ["artifactLocation"]} |
sarif-2.1.0-rtm.5.json | description | A message describing the role played by the attachment. | {} |
sarif-2.1.0-rtm.5.json | artifactLocation | The location of the attachment. | {} |
sarif-2.1.0-rtm.5.json | regions | An array of regions of interest within the attachment. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-2.1.0-rtm.5.json | rectangles | An array of rectangles specifying areas of interest within the image. | {"type": "array", "minItems": 0, "uniqueItems": true, "default": [], "items": {}} |
sarif-2.1.0-rtm.5.json | properties | Key/value pairs that provide additional information about the attachment. | {} |
sarif-2.1.0-rtm.5.json | codeFlow | A set of threadFlows which together describe a pattern of code execution relevant to detecting a result. | {"additionalProperties": false, "type": "object", "properties": {"message": {}, "threadFlows": {"type": "array", "minItems": 1, "uniqueItems": false, "items": {}}, "properties": {}}, "required": ["threadFlows"]} |
sarif-2.1.0-rtm.5.json | message | A message relevant to the code flow. | {} |
sarif-2.1.0-rtm.5.json | threadFlows | An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution. | {"type": "array", "minItems": 1, "uniqueItems": false, "items": {}} |
sarif-2.1.0-rtm.5.json | properties | Key/value pairs that provide additional information about the code flow. | {} |
sarif-2.1.0-rtm.5.json | configurationOverride | Information about how a specific rule or notification was reconfigured at runtime. | {"type": "object", "additionalProperties": false, "properties": {"configuration": {}, "descriptor": {}, "properties": {}}, "required": ["configuration", "descriptor"]} |
sarif-2.1.0-rtm.5.json | configuration | Specifies how the rule or notification was configured during the scan. | {} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.