Debian Codegraph @

gcc/testsuite/lib/sarif-schema-2.1.0.json

raw
1 {
2 "$schema": "http://json-schema.org/draft-04/schema#",
3 "title": "Static Analysis Results Format (SARIF) Version 2.1.0 JSON Schema",
4 "id": "https://docs.oasis-open.org/sarif/sarif/v2.1.0/errata01/os/schemas/sarif-schema-2.1.0.json",
5 "description": "Static Analysis Results Format (SARIF) Version 2.1.0 JSON Schema: a standard format for the output of static analysis tools.",
6 "additionalProperties": false,
7 "type": "object",
8 "properties": {
9
10 "$schema": {
11 "description": "The URI of the JSON schema corresponding to the version.",
12 "type": "string",
13 "format": "uri"
14 },
15
16 "version": {
17 "description": "The SARIF format version of this log file.",
18 "enum": [ "2.1.0" ],
19 "type": "string"
20 },
21
22 "runs": {
23 "description": "The set of runs contained in this log file.",
24 "type": [ "array", "null" ],
25 "minItems": 0,
26 "uniqueItems": false,
27 "items": {
28 "$ref": "#/definitions/run"
29 }
30 },
31
32 "inlineExternalProperties": {
33 "description": "References to external property files that share data between runs.",
34 "type": "array",
35 "minItems": 0,
36 "uniqueItems": true,
37 "items": {
38 "$ref": "#/definitions/externalProperties"
39 }
40 },
41
42 "properties": {
43 "description": "Key/value pairs that provide additional information about the log file.",
44 "$ref": "#/definitions/propertyBag"
45 }
46 },
47
48 "required": [ "version", "runs" ],
49
50 "definitions": {
51
52 "address": {
53 "description": "A physical or virtual address, or a range of addresses, in an 'addressable region' (memory or a binary file).",
54 "additionalProperties": false,
55 "type": "object",
56 "properties": {
57
58 "absoluteAddress": {
59 "description": "The address expressed as a byte offset from the start of the addressable region.",
60 "type": "integer",
61 "minimum": -1,
62 "default": -1
63
64 },
65
66 "relativeAddress": {
67 "description": "The address expressed as a byte offset from the absolute address of the top-most parent object.",
68 "type": "integer"
69
70 },
71
72 "length": {
73 "description": "The number of bytes in this range of addresses.",
74 "type": "integer"
75 },
76
77 "kind": {
78 "description": "An open-ended string that identifies the address kind. 'data', 'function', 'header','instruction', 'module', 'page', 'section', 'segment', 'stack', 'stackFrame', 'table' are well-known values.",
79 "type": "string"
80 },
81
82 "name": {
83 "description": "A name that is associated with the address, e.g., '.text'.",
84 "type": "string"
85 },
86
87 "fullyQualifiedName": {
88 "description": "A human-readable fully qualified name that is associated with the address.",
89 "type": "string"
90 },
91
92 "offsetFromParent": {
93 "description": "The byte offset of this address from the absolute or relative address of the parent object.",
94 "type": "integer"
95 },
96
97 "index": {
98 "description": "The index within run.addresses of the cached object for this address.",
99 "type": "integer",
100 "default": -1,
101 "minimum": -1
102 },
103
104 "parentIndex": {
105 "description": "The index within run.addresses of the parent object.",
106 "type": "integer",
107 "default": -1,
108 "minimum": -1
109 },
110
111 "properties": {
112 "description": "Key/value pairs that provide additional information about the address.",
113 "$ref": "#/definitions/propertyBag"
114 }
115 }
116 },
117
118 "artifact": {
119 "description": "A single artifact. In some cases, this artifact might be nested within another artifact.",
120 "additionalProperties": false,
121 "type": "object",
122 "properties": {
123
124 "description": {
125 "description": "A short description of the artifact.",
126 "$ref": "#/definitions/message"
127 },
128
129 "location": {
130 "description": "The location of the artifact.",
131 "$ref": "#/definitions/artifactLocation"
132 },
133
134 "parentIndex": {
135 "description": "Identifies the index of the immediate parent of the artifact, if this artifact is nested.",
136 "type": "integer",
137 "default": -1,
138 "minimum": -1
139 },
140
141 "offset": {
142 "description": "The offset in bytes of the artifact within its containing artifact.",
143 "type": "integer",
144 "minimum": 0
145 },
146
147 "length": {
148 "description": "The length of the artifact in bytes.",
149 "type": "integer",
150 "default": -1,
151 "minimum": -1
152 },
153
154 "roles": {
155 "description": "The role or roles played by the artifact in the analysis.",
156 "type": "array",
157 "minItems": 0,
158 "uniqueItems": true,
159 "default": [],
160 "items": {
161 "enum": [
162 "analysisTarget",
163 "attachment",
164 "responseFile",
165 "resultFile",
166 "standardStream",
167 "tracedFile",
168 "unmodified",
169 "modified",
170 "added",
171 "deleted",
172 "renamed",
173 "uncontrolled",
174 "driver",
175 "extension",
176 "translation",
177 "taxonomy",
178 "policy",
179 "referencedOnCommandLine",
180 "memoryContents",
181 "directory",
182 "userSpecifiedConfiguration",
183 "toolSpecifiedConfiguration",
184 "debugOutputFile"
185 ],
186 "type": "string"
187 }
188 },
189
190 "mimeType": {
191 "description": "The MIME type (RFC 2045) of the artifact.",
192 "type": "string",
193 "pattern": "[^/]+/.+"
194 },
195
196 "contents": {
197 "description": "The contents of the artifact.",
198 "$ref": "#/definitions/artifactContent"
199 },
200
201 "encoding": {
202 "description": "Specifies the encoding for an artifact object that refers to a text file.",
203 "type": "string"
204 },
205
206 "sourceLanguage": {
207 "description": "Specifies the source language for any artifact object that refers to a text file that contains source code.",
208 "type": "string"
209 },
210
211 "hashes": {
212 "description": "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.",
213 "type": "object",
214 "additionalProperties": {
215 "type": "string"
216 }
217 },
218
219 "lastModifiedTimeUtc": {
220 "description": "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.",
221 "type": "string",
222 "format": "date-time"
223 },
224
225 "properties": {
226 "description": "Key/value pairs that provide additional information about the artifact.",
227 "$ref": "#/definitions/propertyBag"
228 }
229 }
230 },
231
232 "artifactChange": {
233 "description": "A change to a single artifact.",
234 "additionalProperties": false,
235 "type": "object",
236 "properties": {
237
238 "artifactLocation": {
239 "description": "The location of the artifact to change.",
240 "$ref": "#/definitions/artifactLocation"
241 },
242
243 "replacements": {
244 "description": "An array of replacement objects, each of which represents the replacement of a single region in a single artifact specified by 'artifactLocation'.",
245 "type": "array",
246 "minItems": 1,
247 "uniqueItems": false,
248 "items": {
249 "$ref": "#/definitions/replacement"
250 }
251 },
252
253 "properties": {
254 "description": "Key/value pairs that provide additional information about the change.",
255 "$ref": "#/definitions/propertyBag"
256 }
257
258 },
259
260 "required": [ "artifactLocation", "replacements" ]
261 },
262
263 "artifactContent": {
264 "description": "Represents the contents of an artifact.",
265 "type": "object",
266 "additionalProperties": false,
267 "properties": {
268
269 "text": {
270 "description": "UTF-8-encoded content from a text artifact.",
271 "type": "string"
272 },
273
274 "binary": {
275 "description": "MIME Base64-encoded content from a binary artifact, or from a text artifact in its original encoding.",
276 "type": "string"
277 },
278
279 "rendered": {
280 "description": "An alternate rendered representation of the artifact (e.g., a decompiled representation of a binary region).",
281 "$ref": "#/definitions/multiformatMessageString"
282 },
283
284 "properties": {
285 "description": "Key/value pairs that provide additional information about the artifact content.",
286 "$ref": "#/definitions/propertyBag"
287 }
288 }
289 },
290
291 "artifactLocation": {
292 "description": "Specifies the location of an artifact.",
293 "additionalProperties": false,
294 "type": "object",
295 "properties": {
296
297 "uri": {
298 "description": "A string containing a valid relative or absolute URI.",
299 "type": "string",
300 "format": "uri-reference"
301 },
302
303 "uriBaseId": {
304 "description": "A string which indirectly specifies the absolute URI with respect to which a relative URI in the \"uri\" property is interpreted.",
305 "type": "string"
306 },
307
308 "index": {
309 "description": "The index within the run artifacts array of the artifact object associated with the artifact location.",
310 "type": "integer",
311 "default": -1,
312 "minimum": -1
313 },
314
315 "description": {
316 "description": "A short description of the artifact location.",
317 "$ref": "#/definitions/message"
318 },
319
320 "properties": {
321 "description": "Key/value pairs that provide additional information about the artifact location.",
322 "$ref": "#/definitions/propertyBag"
323 }
324 }
325 },
326
327 "attachment": {
328 "description": "An artifact relevant to a result.",
329 "type": "object",
330 "additionalProperties": false,
331 "properties": {
332
333 "description": {
334 "description": "A message describing the role played by the attachment.",
335 "$ref": "#/definitions/message"
336 },
337
338 "artifactLocation": {
339 "description": "The location of the attachment.",
340 "$ref": "#/definitions/artifactLocation"
341 },
342
343 "regions": {
344 "description": "An array of regions of interest within the attachment.",
345 "type": "array",
346 "minItems": 0,
347 "uniqueItems": true,
348 "default": [],
349 "items": {
350 "$ref": "#/definitions/region"
351 }
352 },
353
354 "rectangles": {
355 "description": "An array of rectangles specifying areas of interest within the image.",
356 "type": "array",
357 "minItems": 0,
358 "uniqueItems": true,
359 "default": [],
360 "items": {
361 "$ref": "#/definitions/rectangle"
362 }
363 },
364
365 "properties": {
366 "description": "Key/value pairs that provide additional information about the attachment.",
367 "$ref": "#/definitions/propertyBag"
368 }
369 },
370
371 "required": [ "artifactLocation" ]
372 },
373
374 "codeFlow": {
375 "description": "A set of threadFlows which together describe a pattern of code execution relevant to detecting a result.",
376 "additionalProperties": false,
377 "type": "object",
378 "properties": {
379
380 "message": {
381 "description": "A message relevant to the code flow.",
382 "$ref": "#/definitions/message"
383 },
384
385 "threadFlows": {
386 "description": "An array of one or more unique threadFlow objects, each of which describes the progress of a program through a thread of execution.",
387 "type": "array",
388 "minItems": 1,
389 "uniqueItems": false,
390 "items": {
391 "$ref": "#/definitions/threadFlow"
392 }
393 },
394
395 "properties": {
396 "description": "Key/value pairs that provide additional information about the code flow.",
397 "$ref": "#/definitions/propertyBag"
398 }
399 },
400
401 "required": [ "threadFlows" ]
402 },
403
404 "configurationOverride": {
405 "description": "Information about how a specific rule or notification was reconfigured at runtime.",
406 "type": "object",
407 "additionalProperties": false,
408 "properties": {
409
410 "configuration": {
411 "description": "Specifies how the rule or notification was configured during the scan.",
412 "$ref": "#/definitions/reportingConfiguration"
413 },
414
415 "descriptor": {
416 "description": "A reference used to locate the descriptor whose configuration was overridden.",
417 "$ref": "#/definitions/reportingDescriptorReference"
418 },
419
420 "properties": {
421 "description": "Key/value pairs that provide additional information about the configuration override.",
422 "$ref": "#/definitions/propertyBag"
423 }
424 },
425 "required": [ "configuration", "descriptor" ]
426 },
427
428 "conversion": {
429 "description": "Describes how a converter transformed the output of a static analysis tool from the analysis tool's native output format into the SARIF format.",
430 "additionalProperties": false,
431 "type": "object",
432 "properties": {
433
434 "tool": {
435 "description": "A tool object that describes the converter.",
436 "$ref": "#/definitions/tool"
437 },
438
439 "invocation": {
440 "description": "An invocation object that describes the invocation of the converter.",
441 "$ref": "#/definitions/invocation"
442 },
443
444 "analysisToolLogFiles": {
445 "description": "The locations of the analysis tool's per-run log files.",
446 "type": "array",
447 "minItems": 0,
448 "uniqueItems": true,
449 "default": [],
450 "items": {
451 "$ref": "#/definitions/artifactLocation"
452 }
453 },
454
455 "properties": {
456 "description": "Key/value pairs that provide additional information about the conversion.",
457 "$ref": "#/definitions/propertyBag"
458 }
459
460 },
461
462 "required": [ "tool" ]
463 },
464
465 "edge": {
466 "description": "Represents a directed edge in a graph.",
467 "type": "object",
468 "additionalProperties": false,
469 "properties": {
470
471 "id": {
472 "description": "A string that uniquely identifies the edge within its graph.",
473 "type": "string"
474 },
475
476 "label": {
477 "description": "A short description of the edge.",
478 "$ref": "#/definitions/message"
479 },
480
481 "sourceNodeId": {
482 "description": "Identifies the source node (the node at which the edge starts).",
483 "type": "string"
484 },
485
486 "targetNodeId": {
487 "description": "Identifies the target node (the node at which the edge ends).",
488 "type": "string"
489 },
490
491 "properties": {
492 "description": "Key/value pairs that provide additional information about the edge.",
493 "$ref": "#/definitions/propertyBag"
494 }
495 },
496
497 "required": [ "id", "sourceNodeId", "targetNodeId" ]
498 },
499
500 "edgeTraversal": {
501 "description": "Represents the traversal of a single edge during a graph traversal.",
502 "type": "object",
503 "additionalProperties": false,
504 "properties": {
505
506 "edgeId": {
507 "description": "Identifies the edge being traversed.",
508 "type": "string"
509 },
510
511 "message": {
512 "description": "A message to display to the user as the edge is traversed.",
513 "$ref": "#/definitions/message"
514 },
515
516 "finalState": {
517 "description": "The values of relevant expressions after the edge has been traversed.",
518 "type": "object",
519 "additionalProperties": {
520 "$ref": "#/definitions/multiformatMessageString"
521 }
522 },
523
524 "stepOverEdgeCount": {
525 "description": "The number of edge traversals necessary to return from a nested graph.",
526 "type": "integer",
527 "minimum": 0
528 },
529
530 "properties": {
531 "description": "Key/value pairs that provide additional information about the edge traversal.",
532 "$ref": "#/definitions/propertyBag"
533 }
534 },
535
536 "required": [ "edgeId" ]
537 },
538
539 "exception": {
540 "description": "Describes a runtime exception encountered during the execution of an analysis tool.",
541 "type": "object",
542 "additionalProperties": false,
543 "properties": {
544
545 "kind": {
546 "type": "string",
547 "description": "A string that identifies the kind of exception, for example, the fully qualified type name of an object that was thrown, or the symbolic name of a signal."
548 },
549
550 "message": {
551 "description": "A message that describes the exception.",
552 "type": "string"
553 },
554
555 "stack": {
556 "description": "The sequence of function calls leading to the exception.",
557 "$ref": "#/definitions/stack"
558 },
559
560 "innerExceptions": {
561 "description": "An array of exception objects each of which is considered a cause of this exception.",
562 "type": "array",
563 "minItems": 0,
564 "uniqueItems": false,
565 "default": [],
566 "items": {
567 "$ref": "#/definitions/exception"
568 }
569 },
570
571 "properties": {
572 "description": "Key/value pairs that provide additional information about the exception.",
573 "$ref": "#/definitions/propertyBag"
574 }
575 }
576 },
577
578 "externalProperties": {
579 "description": "The top-level element of an external property file.",
580 "type": "object",
581 "additionalProperties": false,
582 "properties": {
583
584 "schema": {
585 "description": "The URI of the JSON schema corresponding to the version of the external property file format.",
586 "type": "string",
587 "format": "uri"
588 },
589
590 "version": {
591 "description": "The SARIF format version of this external properties object.",
592 "enum": [ "2.1.0" ],
593 "type": "string"
594 },
595
596 "guid": {
597 "description": "A stable, unique identifier for this external properties object, in the form of a GUID.",
598 "type": "string",
599 "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}$"
600 },
601
602 "runGuid": {
603 "description": "A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.",
604 "type": "string",
605 "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}$"
606 },
607
608 "conversion": {
609 "description": "A conversion object that will be merged with a separate run.",
610 "$ref": "#/definitions/conversion"
611 },
612
613 "graphs": {
614 "description": "An array of graph objects that will be merged with a separate run.",
615 "type": "array",
616 "minItems": 0,
617 "default": [],
618 "uniqueItems": true,
619 "items": {
620 "$ref": "#/definitions/graph"
621 }
622 },
623
624 "externalizedProperties": {
625 "description": "Key/value pairs that provide additional information that will be merged with a separate run.",
626 "$ref": "#/definitions/propertyBag"
627 },
628
629 "artifacts": {
630 "description": "An array of artifact objects that will be merged with a separate run.",
631 "type": "array",
632 "minItems": 0,
633 "uniqueItems": true,
634 "items": {
635 "$ref": "#/definitions/artifact"
636 }
637 },
638
639 "invocations": {
640 "description": "Describes the invocation of the analysis tool that will be merged with a separate run.",
641 "type": "array",
642 "minItems": 0,
643 "uniqueItems": false,
644 "default": [],
645 "items": {
646 "$ref": "#/definitions/invocation"
647 }
648 },
649
650 "logicalLocations": {
651 "description": "An array of logical locations such as namespaces, types or functions that will be merged with a separate run.",
652 "type": "array",
653 "minItems": 0,
654 "uniqueItems": true,
655 "default": [],
656 "items": {
657 "$ref": "#/definitions/logicalLocation"
658 }
659 },
660
661 "threadFlowLocations": {
662 "description": "An array of threadFlowLocation objects that will be merged with a separate run.",
663 "type": "array",
664 "minItems": 0,
665 "uniqueItems": true,
666 "default": [],
667 "items": {
668 "$ref": "#/definitions/threadFlowLocation"
669 }
670 },
671
672 "results": {
673 "description": "An array of result objects that will be merged with a separate run.",
674 "type": "array",
675 "minItems": 0,
676 "uniqueItems": false,
677 "default": [],
678 "items": {
679 "$ref": "#/definitions/result"
680 }
681 },
682
683 "taxonomies": {
684 "description": "Tool taxonomies that will be merged with a separate run.",
685 "type": "array",
686 "minItems": 0,
687 "uniqueItems": true,
688 "default": [],
689 "items": {
690 "$ref": "#/definitions/toolComponent"
691 }
692 },
693
694 "driver": {
695 "description": "The analysis tool object that will be merged with a separate run.",
696 "$ref": "#/definitions/toolComponent"
697 },
698
699 "extensions": {
700 "description": "Tool extensions that will be merged with a separate run.",
701 "type": "array",
702 "minItems": 0,
703 "uniqueItems": true,
704 "default": [],
705 "items": {
706 "$ref": "#/definitions/toolComponent"
707 }
708 },
709
710 "policies": {
711 "description": "Tool policies that will be merged with a separate run.",
712 "type": "array",
713 "minItems": 0,
714 "uniqueItems": true,
715 "default": [],
716 "items": {
717 "$ref": "#/definitions/toolComponent"
718 }
719 },
720
721 "translations": {
722 "description": "Tool translations that will be merged with a separate run.",
723 "type": "array",
724 "minItems": 0,
725 "uniqueItems": true,
726 "default": [],
727 "items": {
728 "$ref": "#/definitions/toolComponent"
729 }
730 },
731
732 "addresses": {
733 "description": "Addresses that will be merged with a separate run.",
734 "type": "array",
735 "minItems": 0,
736 "uniqueItems": false,
737 "default": [],
738 "items": {
739 "$ref": "#/definitions/address"
740 }
741 },
742
743 "webRequests": {
744 "description": "Requests that will be merged with a separate run.",
745 "type": "array",
746 "minItems": 0,
747 "uniqueItems": true,
748 "default": [],
749 "items": {
750 "$ref": "#/definitions/webRequest"
751 }
752 },
753
754 "webResponses": {
755 "description": "Responses that will be merged with a separate run.",
756 "type": "array",
757 "minItems": 0,
758 "uniqueItems": true,
759 "default": [],
760 "items": {
761 "$ref": "#/definitions/webResponse"
762 }
763 },
764
765 "properties": {
766 "description": "Key/value pairs that provide additional information about the external properties.",
767 "$ref": "#/definitions/propertyBag"
768 }
769 }
770 },
771
772 "externalPropertyFileReference": {
773 "description": "Contains information that enables a SARIF consumer to locate the external property file that contains the value of an externalized property associated with the run.",
774 "type": "object",
775 "additionalProperties": false,
776 "properties": {
777
778 "location": {
779 "description": "The location of the external property file.",
780 "$ref": "#/definitions/artifactLocation"
781 },
782
783 "guid": {
784 "description": "A stable, unique identifier for the external property file in the form of a GUID.",
785 "type": "string",
786 "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}$"
787 },
788
789 "itemCount": {
790 "description": "A non-negative integer specifying the number of items contained in the external property file.",
791 "type": "integer",
792 "default": -1,
793 "minimum": -1
794 },
795
796 "properties": {
797 "description": "Key/value pairs that provide additional information about the external property file.",
798 "$ref": "#/definitions/propertyBag"
799 }
800 },
801 "anyOf": [
802 { "required": [ "location" ] },
803 { "required": [ "guid" ] }
804 ]
805 },
806
807 "externalPropertyFileReferences": {
808 "description": "References to external property files that should be inlined with the content of a root log file.",
809 "additionalProperties": false,
810 "type": "object",
811 "properties": {
812
813 "conversion": {
814 "description": "An external property file containing a run.conversion object to be merged with the root log file.",
815 "$ref": "#/definitions/externalPropertyFileReference"
816 },
817
818 "graphs": {
819 "description": "An array of external property files containing a run.graphs object to be merged with the root log file.",
820 "type": "array",
821 "minItems": 0,
822 "uniqueItems": true,
823 "default": [],
824 "items": {
825 "$ref": "#/definitions/externalPropertyFileReference"
826 }
827 },
828
829 "externalizedProperties": {
830 "description": "An external property file containing a run.properties object to be merged with the root log file.",
831 "$ref": "#/definitions/externalPropertyFileReference"
832 },
833
834 "artifacts": {
835 "description": "An array of external property files containing run.artifacts arrays to be merged with the root log file.",
836 "type": "array",
837 "minItems": 0,
838 "uniqueItems": true,
839 "default": [],
840 "items": {
841 "$ref": "#/definitions/externalPropertyFileReference"
842 }
843 },
844
845 "invocations": {
846 "description": "An array of external property files containing run.invocations arrays to be merged with the root log file.",
847 "type": "array",
848 "minItems": 0,
849 "uniqueItems": true,
850 "default": [],
851 "items": {
852 "$ref": "#/definitions/externalPropertyFileReference"
853 }
854 },
855
856 "logicalLocations": {
857 "description": "An array of external property files containing run.logicalLocations arrays to be merged with the root log file.",
858 "type": "array",
859 "minItems": 0,
860 "uniqueItems": true,
861 "default": [],
862 "items": {
863 "$ref": "#/definitions/externalPropertyFileReference"
864 }
865 },
866
867 "threadFlowLocations": {
868 "description": "An array of external property files containing run.threadFlowLocations arrays to be merged with the root log file.",
869 "type": "array",
870 "minItems": 0,
871 "uniqueItems": true,
872 "default": [],
873 "items": {
874 "$ref": "#/definitions/externalPropertyFileReference"
875 }
876 },
877
878 "results": {
879 "description": "An array of external property files containing run.results arrays to be merged with the root log file.",
880 "type": "array",
881 "minItems": 0,
882 "uniqueItems": true,
883 "default": [],
884 "items": {
885 "$ref": "#/definitions/externalPropertyFileReference"
886 }
887 },
888
889 "taxonomies": {
890 "description": "An array of external property files containing run.taxonomies arrays to be merged with the root log file.",
891 "type": "array",
892 "minItems": 0,
893 "uniqueItems": true,
894 "default": [],
895 "items": {
896 "$ref": "#/definitions/externalPropertyFileReference"
897 }
898 },
899
900 "addresses": {
901 "description": "An array of external property files containing run.addresses arrays to be merged with the root log file.",
902 "type": "array",
903 "minItems": 0,
904 "uniqueItems": true,
905 "default": [],
906 "items": {
907 "$ref": "#/definitions/externalPropertyFileReference"
908 }
909 },
910
911 "driver": {
912 "description": "An external property file containing a run.driver object to be merged with the root log file.",
913 "$ref": "#/definitions/externalPropertyFileReference"
914 },
915
916 "extensions": {
917 "description": "An array of external property files containing run.extensions arrays to be merged with the root log file.",
918 "type": "array",
919 "minItems": 0,
920 "uniqueItems": true,
921 "default": [],
922 "items": {
923 "$ref": "#/definitions/externalPropertyFileReference"
924 }
925 },
926
927 "policies": {
928 "description": "An array of external property files containing run.policies arrays to be merged with the root log file.",
929 "type": "array",
930 "minItems": 0,
931 "uniqueItems": true,
932 "default": [],
933 "items": {
934 "$ref": "#/definitions/externalPropertyFileReference"
935 }
936 },
937
938 "translations": {
939 "description": "An array of external property files containing run.translations arrays to be merged with the root log file.",
940 "type": "array",
941 "minItems": 0,
942 "uniqueItems": true,
943 "default": [],
944 "items": {
945 "$ref": "#/definitions/externalPropertyFileReference"
946 }
947 },
948
949 "webRequests": {
950 "description": "An array of external property files containing run.requests arrays to be merged with the root log file.",
951 "type": "array",
952 "minItems": 0,
953 "uniqueItems": true,
954 "default": [],
955 "items": {
956 "$ref": "#/definitions/externalPropertyFileReference"
957 }
958 },
959
960 "webResponses": {
961 "description": "An array of external property files containing run.responses arrays to be merged with the root log file.",
962 "type": "array",
963 "minItems": 0,
964 "uniqueItems": true,
965 "default": [],
966 "items": {
967 "$ref": "#/definitions/externalPropertyFileReference"
968 }
969 },
970
971 "properties": {
972 "description": "Key/value pairs that provide additional information about the external property files.",
973 "$ref": "#/definitions/propertyBag"
974 }
975 }
976 },
977
978 "fix": {
979 "description": "A proposed fix for the problem represented by a result object. A fix specifies a set of artifacts to modify. For each artifact, it specifies a set of bytes to remove, and provides a set of new bytes to replace them.",
980 "additionalProperties": false,
981 "type": "object",
982 "properties": {
983
984 "description": {
985 "description": "A message that describes the proposed fix, enabling viewers to present the proposed change to an end user.",
986 "$ref": "#/definitions/message"
987 },
988
989 "artifactChanges": {
990 "description": "One or more artifact changes that comprise a fix for a result.",
991 "type": "array",
992 "minItems": 1,
993 "uniqueItems": true,
994 "items": {
995 "$ref": "#/definitions/artifactChange"
996 }
997 },
998
999 "properties": {
1000 "description": "Key/value pairs that provide additional information about the fix.",
1001 "$ref": "#/definitions/propertyBag"
1002 }
1003 },
1004 "required": [ "artifactChanges" ]
1005 },
1006
1007 "graph": {
1008 "description": "A network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).",
1009 "type": "object",
1010 "additionalProperties": false,
1011 "properties": {
1012
1013 "description": {
1014 "description": "A description of the graph.",
1015 "$ref": "#/definitions/message"
1016 },
1017
1018 "nodes": {
1019 "description": "An array of node objects representing the nodes of the graph.",
1020 "type": "array",
1021 "minItems": 0,
1022 "uniqueItems": true,
1023 "default": [],
1024 "items": {
1025 "$ref": "#/definitions/node"
1026 }
1027 },
1028
1029 "edges": {
1030 "description": "An array of edge objects representing the edges of the graph.",
1031 "type": "array",
1032 "minItems": 0,
1033 "uniqueItems": true,
1034 "default": [],
1035 "items": {
1036 "$ref": "#/definitions/edge"
1037 }
1038 },
1039
1040 "properties": {
1041 "description": "Key/value pairs that provide additional information about the graph.",
1042 "$ref": "#/definitions/propertyBag"
1043 }
1044 }
1045 },
1046
1047 "graphTraversal": {
1048 "description": "Represents a path through a graph.",
1049 "type": "object",
1050 "additionalProperties": false,
1051 "properties": {
1052
1053 "runGraphIndex": {
1054 "description": "The index within the run.graphs to be associated with the result.",
1055 "type": "integer",
1056 "default": -1,
1057 "minimum": -1
1058 },
1059
1060 "resultGraphIndex": {
1061 "description": "The index within the result.graphs to be associated with the result.",
1062 "type": "integer",
1063 "default": -1,
1064 "minimum": -1
1065 },
1066
1067 "description": {
1068 "description": "A description of this graph traversal.",
1069 "$ref": "#/definitions/message"
1070 },
1071
1072 "initialState": {
1073 "description": "Values of relevant expressions at the start of the graph traversal that may change during graph traversal.",
1074 "type": "object",
1075 "additionalProperties": {
1076 "$ref": "#/definitions/multiformatMessageString"
1077 }
1078 },
1079
1080 "immutableState": {
1081 "description": "Values of relevant expressions at the start of the graph traversal that remain constant for the graph traversal.",
1082 "type": "object",
1083 "additionalProperties": {
1084 "$ref": "#/definitions/multiformatMessageString"
1085 }
1086 },
1087
1088 "edgeTraversals": {
1089 "description": "The sequences of edges traversed by this graph traversal.",
1090 "type": "array",
1091 "minItems": 0,
1092 "uniqueItems": false,
1093 "default": [],
1094 "items": {
1095 "$ref": "#/definitions/edgeTraversal"
1096 }
1097 },
1098
1099 "properties": {
1100 "description": "Key/value pairs that provide additional information about the graph traversal.",
1101 "$ref": "#/definitions/propertyBag"
1102 }
1103 },
1104 "oneOf": [
1105 { "required": [ "runGraphIndex" ] },
1106 { "required": [ "resultGraphIndex" ] }
1107 ]
1108 },
1109
1110 "invocation": {
1111 "description": "The runtime environment of the analysis tool run.",
1112 "additionalProperties": false,
1113 "type": "object",
1114 "properties": {
1115
1116 "commandLine": {
1117 "description": "The command line used to invoke the tool.",
1118 "type": "string"
1119 },
1120
1121 "arguments": {
1122 "description": "An array of strings, containing in order the command line arguments passed to the tool from the operating system.",
1123 "type": "array",
1124 "minItems": 0,
1125 "uniqueItems": false,
1126 "items": {
1127 "type": "string"
1128 }
1129 },
1130
1131 "responseFiles": {
1132 "description": "The locations of any response files specified on the tool's command line.",
1133 "type": "array",
1134 "minItems": 0,
1135 "uniqueItems": true,
1136 "items": {
1137 "$ref": "#/definitions/artifactLocation"
1138 }
1139 },
1140
1141 "startTimeUtc": {
1142 "description": "The Coordinated Universal Time (UTC) date and time at which the invocation started. See \"Date/time properties\" in the SARIF spec for the required format.",
1143 "type": "string",
1144 "format": "date-time"
1145 },
1146
1147 "endTimeUtc": {
1148 "description": "The Coordinated Universal Time (UTC) date and time at which the invocation ended. See \"Date/time properties\" in the SARIF spec for the required format.",
1149 "type": "string",
1150 "format": "date-time"
1151 },
1152
1153 "exitCode": {
1154 "description": "The process exit code.",
1155 "type": "integer"
1156 },
1157
1158 "ruleConfigurationOverrides": {
1159 "description": "An array of configurationOverride objects that describe rules related runtime overrides.",
1160 "type": "array",
1161 "minItems": 0,
1162 "default": [],
1163 "uniqueItems": true,
1164 "items": {
1165 "$ref": "#/definitions/configurationOverride"
1166 }
1167 },
1168
1169 "notificationConfigurationOverrides": {
1170 "description": "An array of configurationOverride objects that describe notifications related runtime overrides.",
1171 "type": "array",
1172 "minItems": 0,
1173 "default": [],
1174 "uniqueItems": true,
1175 "items": {
1176 "$ref": "#/definitions/configurationOverride"
1177 }
1178 },
1179
1180 "toolExecutionNotifications": {
1181 "description": "A list of runtime conditions detected by the tool during the analysis.",
1182 "type": "array",
1183 "minItems": 0,
1184 "uniqueItems": false,
1185 "default": [],
1186 "items": {
1187 "$ref": "#/definitions/notification"
1188 }
1189 },
1190
1191 "toolConfigurationNotifications": {
1192 "description": "A list of conditions detected by the tool that are relevant to the tool's configuration.",
1193 "type": "array",
1194 "minItems": 0,
1195 "uniqueItems": false,
1196 "default": [],
1197 "items": {
1198 "$ref": "#/definitions/notification"
1199 }
1200 },
1201
1202 "exitCodeDescription": {
1203 "description": "The reason for the process exit.",
1204 "type": "string"
1205 },
1206
1207 "exitSignalName": {
1208 "description": "The name of the signal that caused the process to exit.",
1209 "type": "string"
1210 },
1211
1212 "exitSignalNumber": {
1213 "description": "The numeric value of the signal that caused the process to exit.",
1214 "type": "integer"
1215 },
1216
1217 "processStartFailureMessage": {
1218 "description": "The reason given by the operating system that the process failed to start.",
1219 "type": "string"
1220 },
1221
1222 "executionSuccessful": {
1223 "description": "Specifies whether the tool's execution completed successfully.",
1224 "type": "boolean"
1225 },
1226
1227 "machine": {
1228 "description": "The machine on which the invocation occurred.",
1229 "type": "string"
1230 },
1231
1232 "account": {
1233 "description": "The account under which the invocation occurred.",
1234 "type": "string"
1235 },
1236
1237 "processId": {
1238 "description": "The id of the process in which the invocation occurred.",
1239 "type": "integer"
1240 },
1241
1242 "executableLocation": {
1243 "description": "An absolute URI specifying the location of the executable that was invoked.",
1244 "$ref": "#/definitions/artifactLocation"
1245 },
1246
1247 "workingDirectory": {
1248 "description": "The working directory for the invocation.",
1249 "$ref": "#/definitions/artifactLocation"
1250 },
1251
1252 "environmentVariables": {
1253 "description": "The environment variables associated with the analysis tool process, expressed as key/value pairs.",
1254 "type": "object",
1255 "additionalProperties": {
1256 "type": "string"
1257 }
1258 },
1259
1260 "stdin": {
1261 "description": "A file containing the standard input stream to the process that was invoked.",
1262 "$ref": "#/definitions/artifactLocation"
1263 },
1264
1265 "stdout": {
1266 "description": "A file containing the standard output stream from the process that was invoked.",
1267 "$ref": "#/definitions/artifactLocation"
1268 },
1269
1270 "stderr": {
1271 "description": "A file containing the standard error stream from the process that was invoked.",
1272 "$ref": "#/definitions/artifactLocation"
1273 },
1274
1275 "stdoutStderr": {
1276 "description": "A file containing the interleaved standard output and standard error stream from the process that was invoked.",
1277 "$ref": "#/definitions/artifactLocation"
1278 },
1279
1280 "properties": {
1281 "description": "Key/value pairs that provide additional information about the invocation.",
1282 "$ref": "#/definitions/propertyBag"
1283 }
1284 },
1285 "required": [ "executionSuccessful" ]
1286 },
1287
1288 "location": {
1289 "description": "A location within a programming artifact.",
1290 "additionalProperties": false,
1291 "type": "object",
1292 "properties": {
1293
1294 "id": {
1295 "description": "Value that distinguishes this location from all other locations within a single result object.",
1296 "type": "integer",
1297 "minimum": -1,
1298 "default": -1
1299 },
1300
1301 "physicalLocation": {
1302 "description": "Identifies the artifact and region.",
1303 "$ref": "#/definitions/physicalLocation"
1304 },
1305
1306 "logicalLocations": {
1307 "description": "The logical locations associated with the result.",
1308 "type": "array",
1309 "minItems": 0,
1310 "uniqueItems": true,
1311 "default": [],
1312 "items": {
1313 "$ref": "#/definitions/logicalLocation"
1314 }
1315 },
1316
1317 "message": {
1318 "description": "A message relevant to the location.",
1319 "$ref": "#/definitions/message"
1320 },
1321
1322 "annotations": {
1323 "description": "A set of regions relevant to the location.",
1324 "type": "array",
1325 "minItems": 0,
1326 "uniqueItems": true,
1327 "default": [],
1328 "items": {
1329 "$ref": "#/definitions/region"
1330 }
1331 },
1332
1333 "relationships": {
1334 "description": "An array of objects that describe relationships between this location and others.",
1335 "type": "array",
1336 "default": [],
1337 "minItems": 0,
1338 "uniqueItems": true,
1339 "items": {
1340 "$ref": "#/definitions/locationRelationship"
1341 }
1342 },
1343
1344 "properties": {
1345 "description": "Key/value pairs that provide additional information about the location.",
1346 "$ref": "#/definitions/propertyBag"
1347 }
1348 }
1349 },
1350
1351 "locationRelationship": {
1352 "description": "Information about the relation of one location to another.",
1353 "type": "object",
1354 "additionalProperties": false,
1355 "properties": {
1356
1357 "target": {
1358 "description": "A reference to the related location.",
1359 "type": "integer",
1360 "minimum": 0
1361 },
1362
1363 "kinds": {
1364 "description": "A set of distinct strings that categorize the relationship. Well-known kinds include 'includes', 'isIncludedBy' and 'relevant'.",
1365 "type": "array",
1366 "default": [ "relevant" ],
1367 "uniqueItems": true,
1368 "items": {
1369 "type": "string"
1370 }
1371 },
1372
1373 "description": {
1374 "description": "A description of the location relationship.",
1375 "$ref": "#/definitions/message"
1376 },
1377
1378 "properties": {
1379 "description": "Key/value pairs that provide additional information about the location relationship.",
1380 "$ref": "#/definitions/propertyBag"
1381 }
1382 },
1383 "required": [ "target" ]
1384 },
1385
1386 "logicalLocation": {
1387 "description": "A logical location of a construct that produced a result.",
1388 "additionalProperties": false,
1389 "type": "object",
1390 "properties": {
1391
1392 "name": {
1393 "description": "Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.",
1394 "type": "string"
1395 },
1396
1397 "index": {
1398 "description": "The index within the logical locations array.",
1399 "type": "integer",
1400 "default": -1,
1401 "minimum": -1
1402 },
1403
1404 "fullyQualifiedName": {
1405 "description": "The human-readable fully qualified name of the logical location.",
1406 "type": "string"
1407 },
1408
1409 "decoratedName": {
1410 "description": "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.",
1411 "type": "string"
1412 },
1413
1414 "parentIndex": {
1415 "description": "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.",
1416 "type": "integer",
1417 "default": -1,
1418 "minimum": -1
1419 },
1420
1421 "kind": {
1422 "description": "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.",
1423 "type": "string"
1424 },
1425
1426 "properties": {
1427 "description": "Key/value pairs that provide additional information about the logical location.",
1428 "$ref": "#/definitions/propertyBag"
1429 }
1430 }
1431 },
1432
1433 "message": {
1434 "description": "Encapsulates a message intended to be read by the end user.",
1435 "type": "object",
1436 "additionalProperties": false,
1437
1438 "properties": {
1439
1440 "text": {
1441 "description": "A plain text message string.",
1442 "type": "string"
1443 },
1444
1445 "markdown": {
1446 "description": "A Markdown message string.",
1447 "type": "string"
1448 },
1449
1450 "id": {
1451 "description": "The identifier for this message.",
1452 "type": "string"
1453 },
1454
1455 "arguments": {
1456 "description": "An array of strings to substitute into the message string.",
1457 "type": "array",
1458 "minItems": 0,
1459 "uniqueItems": false,
1460 "default": [],
1461 "items": {
1462 "type": "string"
1463 }
1464 },
1465
1466 "properties": {
1467 "description": "Key/value pairs that provide additional information about the message.",
1468 "$ref": "#/definitions/propertyBag"
1469 }
1470 },
1471 "anyOf": [
1472 { "required": [ "text" ] },
1473 { "required": [ "id" ] }
1474 ]
1475 },
1476
1477 "multiformatMessageString": {
1478 "description": "A message string or message format string rendered in multiple formats.",
1479 "type": "object",
1480 "additionalProperties": false,
1481
1482 "properties": {
1483
1484 "text": {
1485 "description": "A plain text message string or format string.",
1486 "type": "string"
1487 },
1488
1489 "markdown": {
1490 "description": "A Markdown message string or format string.",
1491 "type": "string"
1492 },
1493
1494 "properties": {
1495 "description": "Key/value pairs that provide additional information about the message.",
1496 "$ref": "#/definitions/propertyBag"
1497 }
1498 },
1499 "required": [ "text" ]
1500 },
1501
1502 "node": {
1503 "description": "Represents a node in a graph.",
1504 "type": "object",
1505 "additionalProperties": false,
1506
1507 "properties": {
1508
1509 "id": {
1510 "description": "A string that uniquely identifies the node within its graph.",
1511 "type": "string"
1512 },
1513
1514 "label": {
1515 "description": "A short description of the node.",
1516 "$ref": "#/definitions/message"
1517 },
1518
1519 "location": {
1520 "description": "A code location associated with the node.",
1521 "$ref": "#/definitions/location"
1522 },
1523
1524 "children": {
1525 "description": "Array of child nodes.",
1526 "type": "array",
1527 "minItems": 0,
1528 "uniqueItems": true,
1529 "default": [],
1530 "items": {
1531 "$ref": "#/definitions/node"
1532 }
1533 },
1534
1535 "properties": {
1536 "description": "Key/value pairs that provide additional information about the node.",
1537 "$ref": "#/definitions/propertyBag"
1538 }
1539 },
1540
1541 "required": [ "id" ]
1542 },
1543
1544 "notification": {
1545 "description": "Describes a condition relevant to the tool itself, as opposed to being relevant to a target being analyzed by the tool.",
1546 "type": "object",
1547 "additionalProperties": false,
1548 "properties": {
1549
1550 "locations": {
1551 "description": "The locations relevant to this notification.",
1552 "type": "array",
1553 "minItems": 0,
1554 "uniqueItems": true,
1555 "default": [],
1556 "items": {
1557 "$ref": "#/definitions/location"
1558 }
1559 },
1560
1561 "message": {
1562 "description": "A message that describes the condition that was encountered.",
1563 "$ref": "#/definitions/message"
1564 },
1565
1566 "level": {
1567 "description": "A value specifying the severity level of the notification.",
1568 "default": "warning",
1569 "enum": [ "none", "note", "warning", "error" ],
1570 "type": "string"
1571 },
1572
1573 "threadId": {
1574 "description": "The thread identifier of the code that generated the notification.",
1575 "type": "integer"
1576 },
1577
1578 "timeUtc": {
1579 "description": "The Coordinated Universal Time (UTC) date and time at which the analysis tool generated the notification.",
1580 "type": "string",
1581 "format": "date-time"
1582 },
1583
1584 "exception": {
1585 "description": "The runtime exception, if any, relevant to this notification.",
1586 "$ref": "#/definitions/exception"
1587 },
1588
1589 "descriptor": {
1590 "description": "A reference used to locate the descriptor relevant to this notification.",
1591 "$ref": "#/definitions/reportingDescriptorReference"
1592 },
1593
1594 "associatedRule": {
1595 "description": "A reference used to locate the rule descriptor associated with this notification.",
1596 "$ref": "#/definitions/reportingDescriptorReference"
1597 },
1598
1599 "properties": {
1600 "description": "Key/value pairs that provide additional information about the notification.",
1601 "$ref": "#/definitions/propertyBag"
1602 }
1603 },
1604
1605 "required": [ "message" ]
1606 },
1607
1608 "physicalLocation": {
1609 "description": "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.",
1610 "additionalProperties": false,
1611 "type": "object",
1612 "properties": {
1613
1614 "address": {
1615 "description": "The address of the location.",
1616 "$ref": "#/definitions/address"
1617 },
1618
1619 "artifactLocation": {
1620 "description": "The location of the artifact.",
1621 "$ref": "#/definitions/artifactLocation"
1622 },
1623
1624 "region": {
1625 "description": "Specifies a portion of the artifact.",
1626 "$ref": "#/definitions/region"
1627 },
1628
1629 "contextRegion": {
1630 "description": "Specifies a portion of the artifact that encloses the region. Allows a viewer to display additional context around the region.",
1631 "$ref": "#/definitions/region"
1632 },
1633
1634 "properties": {
1635 "description": "Key/value pairs that provide additional information about the physical location.",
1636 "$ref": "#/definitions/propertyBag"
1637 }
1638 },
1639
1640 "anyOf": [
1641 {
1642 "required": [ "address" ]
1643 },
1644 {
1645 "required": [ "artifactLocation" ]
1646 }
1647 ]
1648 },
1649
1650 "propertyBag": {
1651 "description": "Key/value pairs that provide additional information about the object.",
1652 "type": "object",
1653 "additionalProperties": true,
1654 "properties": {
1655 "tags": {
1656
1657 "description": "A set of distinct strings that provide additional information.",
1658 "type": "array",
1659 "minItems": 0,
1660 "uniqueItems": true,
1661 "default": [],
1662 "items": {
1663 "type": "string"
1664 }
1665 }
1666 }
1667 },
1668
1669 "rectangle": {
1670 "description": "An area within an image.",
1671 "additionalProperties": false,
1672 "type": "object",
1673 "properties": {
1674
1675 "top": {
1676 "description": "The Y coordinate of the top edge of the rectangle, measured in the image's natural units.",
1677 "type": "number"
1678 },
1679
1680 "left": {
1681 "description": "The X coordinate of the left edge of the rectangle, measured in the image's natural units.",
1682 "type": "number"
1683 },
1684
1685 "bottom": {
1686 "description": "The Y coordinate of the bottom edge of the rectangle, measured in the image's natural units.",
1687 "type": "number"
1688 },
1689
1690 "right": {
1691 "description": "The X coordinate of the right edge of the rectangle, measured in the image's natural units.",
1692 "type": "number"
1693 },
1694
1695 "message": {
1696 "description": "A message relevant to the rectangle.",
1697 "$ref": "#/definitions/message"
1698 },
1699
1700 "properties": {
1701 "description": "Key/value pairs that provide additional information about the rectangle.",
1702 "$ref": "#/definitions/propertyBag"
1703 }
1704 }
1705 },
1706
1707 "region": {
1708 "description": "A region within an artifact where a result was detected.",
1709 "additionalProperties": false,
1710 "type": "object",
1711 "properties": {
1712
1713 "startLine": {
1714 "description": "The line number of the first character in the region.",
1715 "type": "integer",
1716 "minimum": 1
1717 },
1718
1719 "startColumn": {
1720 "description": "The column number of the first character in the region.",
1721 "type": "integer",
1722 "minimum": 1
1723 },
1724
1725 "endLine": {
1726 "description": "The line number of the last character in the region.",
1727 "type": "integer",
1728 "minimum": 1
1729 },
1730
1731 "endColumn": {
1732 "description": "The column number of the character following the end of the region.",
1733 "type": "integer",
1734 "minimum": 1
1735 },
1736
1737 "charOffset": {
1738 "description": "The zero-based offset from the beginning of the artifact of the first character in the region.",
1739 "type": "integer",
1740 "default": -1,
1741 "minimum": -1
1742 },
1743
1744 "charLength": {
1745 "description": "The length of the region in characters.",
1746 "type": "integer",
1747 "minimum": 0
1748 },
1749
1750 "byteOffset": {
1751 "description": "The zero-based offset from the beginning of the artifact of the first byte in the region.",
1752 "type": "integer",
1753 "default": -1,
1754 "minimum": -1
1755 },
1756
1757 "byteLength": {
1758 "description": "The length of the region in bytes.",
1759 "type": "integer",
1760 "minimum": 0
1761 },
1762
1763 "snippet": {
1764 "description": "The portion of the artifact contents within the specified region.",
1765 "$ref": "#/definitions/artifactContent"
1766 },
1767
1768 "message": {
1769 "description": "A message relevant to the region.",
1770 "$ref": "#/definitions/message"
1771 },
1772
1773 "sourceLanguage": {
1774 "description": "Specifies the source language, if any, of the portion of the artifact specified by the region object.",
1775 "type": "string"
1776 },
1777
1778 "properties": {
1779 "description": "Key/value pairs that provide additional information about the region.",
1780 "$ref": "#/definitions/propertyBag"
1781 }
1782 },
1783
1784 "anyOf": [
1785 { "required": [ "startLine" ] },
1786 { "required": [ "charOffset" ] },
1787 { "required": [ "byteOffset" ] }
1788 ]
1789 },
1790
1791 "replacement": {
1792 "description": "The replacement of a single region of an artifact.",
1793 "additionalProperties": false,
1794 "type": "object",
1795 "properties": {
1796
1797 "deletedRegion": {
1798 "description": "The region of the artifact to delete.",
1799 "$ref": "#/definitions/region"
1800 },
1801
1802 "insertedContent": {
1803 "description": "The content to insert at the location specified by the 'deletedRegion' property.",
1804 "$ref": "#/definitions/artifactContent"
1805 },
1806
1807 "properties": {
1808 "description": "Key/value pairs that provide additional information about the replacement.",
1809 "$ref": "#/definitions/propertyBag"
1810 }
1811 },
1812
1813 "required": [ "deletedRegion" ]
1814 },
1815
1816 "reportingDescriptor": {
1817 "description": "Metadata that describes a specific report produced by the tool, as part of the analysis it provides or its runtime reporting.",
1818 "additionalProperties": false,
1819 "type": "object",
1820 "properties": {
1821
1822 "id": {
1823 "description": "A stable, opaque identifier for the report.",
1824 "type": "string"
1825 },
1826
1827 "deprecatedIds": {
1828 "description": "An array of stable, opaque identifiers by which this report was known in some previous version of the analysis tool.",
1829 "type": "array",
1830 "minItems": 0,
1831 "uniqueItems": true,
1832 "items": {
1833 "type": "string"
1834 }
1835 },
1836
1837 "guid": {
1838 "description": "A unique identifier for the reporting descriptor in the form of a GUID.",
1839 "type": "string",
1840 "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}$"
1841 },
1842
1843 "deprecatedGuids": {
1844 "description": "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.",
1845 "type": "array",
1846 "minItems": 0,
1847 "uniqueItems": true,
1848 "items": {
1849 "type": "string",
1850 "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}$"
1851 }
1852 },
1853
1854 "name": {
1855 "description": "A report identifier that is understandable to an end user.",
1856 "type": "string"
1857 },
1858
1859 "deprecatedNames": {
1860 "description": "An array of readable identifiers by which this report was known in some previous version of the analysis tool.",
1861 "type": "array",
1862 "minItems": 0,
1863 "uniqueItems": true,
1864 "items": {
1865 "type": "string"
1866 }
1867 },
1868
1869 "shortDescription": {
1870 "description": "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.",
1871 "$ref": "#/definitions/multiformatMessageString"
1872 },
1873
1874 "fullDescription": {
1875 "description": "A description of the report. Should, as far as possible, provide details sufficient to enable resolution of any problem indicated by the result.",
1876 "$ref": "#/definitions/multiformatMessageString"
1877 },
1878
1879 "messageStrings": {
1880 "description": "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.",
1881 "type": "object",
1882 "additionalProperties": {
1883 "$ref": "#/definitions/multiformatMessageString"
1884 }
1885 },
1886
1887 "defaultConfiguration": {
1888 "description": "Default reporting configuration information.",
1889 "$ref": "#/definitions/reportingConfiguration"
1890 },
1891
1892 "helpUri": {
1893 "description": "A URI where the primary documentation for the report can be found.",
1894 "type": "string",
1895 "format": "uri"
1896 },
1897
1898 "help": {
1899 "description": "Provides the primary documentation for the report, useful when there is no online documentation.",
1900 "$ref": "#/definitions/multiformatMessageString"
1901 },
1902
1903 "relationships": {
1904 "description": "An array of objects that describe relationships between this reporting descriptor and others.",
1905 "type": "array",
1906 "default": [],
1907 "minItems": 0,
1908 "uniqueItems": true,
1909 "items": {
1910 "$ref": "#/definitions/reportingDescriptorRelationship"
1911 }
1912 },
1913
1914 "properties": {
1915 "description": "Key/value pairs that provide additional information about the report.",
1916 "$ref": "#/definitions/propertyBag"
1917 }
1918 },
1919 "required": [ "id" ]
1920 },
1921
1922 "reportingConfiguration": {
1923 "description": "Information about a rule or notification that can be configured at runtime.",
1924 "type": "object",
1925 "additionalProperties": false,
1926 "properties": {
1927
1928 "enabled": {
1929 "description": "Specifies whether the report may be produced during the scan.",
1930 "type": "boolean",
1931 "default": true
1932 },
1933
1934 "level": {
1935 "description": "Specifies the failure level for the report.",
1936 "default": "warning",
1937 "enum": [ "none", "note", "warning", "error" ],
1938 "type": "string"
1939 },
1940
1941 "rank": {
1942 "description": "Specifies the relative priority of the report. Used for analysis output only.",
1943 "type": "number",
1944 "default": -1.0,
1945 "minimum": -1.0,
1946 "maximum": 100.0
1947 },
1948
1949 "parameters": {
1950 "description": "Contains configuration information specific to a report.",
1951 "$ref": "#/definitions/propertyBag"
1952 },
1953
1954 "properties": {
1955 "description": "Key/value pairs that provide additional information about the reporting configuration.",
1956 "$ref": "#/definitions/propertyBag"
1957 }
1958 }
1959 },
1960
1961 "reportingDescriptorReference": {
1962 "description": "Information about how to locate a relevant reporting descriptor.",
1963 "type": "object",
1964 "additionalProperties": false,
1965 "properties": {
1966
1967 "id": {
1968 "description": "The id of the descriptor.",
1969 "type": "string"
1970 },
1971
1972 "index": {
1973 "description": "The index into an array of descriptors in toolComponent.ruleDescriptors, toolComponent.notificationDescriptors, or toolComponent.taxonomyDescriptors, depending on context.",
1974 "type": "integer",
1975 "default": -1,
1976 "minimum": -1
1977 },
1978
1979 "guid": {
1980 "description": "A guid that uniquely identifies the descriptor.",
1981 "type": "string",
1982 "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}$"
1983 },
1984
1985 "toolComponent": {
1986 "description": "A reference used to locate the toolComponent associated with the descriptor.",
1987 "$ref": "#/definitions/toolComponentReference"
1988 },
1989
1990 "properties": {
1991 "description": "Key/value pairs that provide additional information about the reporting descriptor reference.",
1992 "$ref": "#/definitions/propertyBag"
1993 }
1994 },
1995 "anyOf": [
1996 { "required": [ "index" ] },
1997 { "required": [ "guid" ] },
1998 { "required": [ "id" ] }
1999 ]
2000 },
2001
2002 "reportingDescriptorRelationship": {
2003 "description": "Information about the relation of one reporting descriptor to another.",
2004 "type": "object",
2005 "additionalProperties": false,
2006 "properties": {
2007
2008 "target": {
2009 "description": "A reference to the related reporting descriptor.",
2010 "$ref": "#/definitions/reportingDescriptorReference"
2011 },
2012
2013 "kinds": {
2014 "description": "A set of distinct strings that categorize the relationship. Well-known kinds include 'canPrecede', 'canFollow', 'willPrecede', 'willFollow', 'superset', 'subset', 'equal', 'disjoint', 'relevant', and 'incomparable'.",
2015 "type": "array",
2016 "default": [ "relevant" ],
2017 "uniqueItems": true,
2018 "items": {
2019 "type": "string"
2020 }
2021 },
2022
2023 "description": {
2024 "description": "A description of the reporting descriptor relationship.",
2025 "$ref": "#/definitions/message"
2026 },
2027
2028 "properties": {
2029 "description": "Key/value pairs that provide additional information about the reporting descriptor reference.",
2030 "$ref": "#/definitions/propertyBag"
2031 }
2032 },
2033 "required": [ "target" ]
2034 },
2035
2036 "result": {
2037 "description": "A result produced by an analysis tool.",
2038 "additionalProperties": false,
2039 "type": "object",
2040 "properties": {
2041
2042 "ruleId": {
2043 "description": "The stable, unique identifier of the rule, if any, to which this result is relevant.",
2044 "type": "string"
2045 },
2046
2047 "ruleIndex": {
2048 "description": "The index within the tool component rules array of the rule object associated with this result.",
2049 "type": "integer",
2050 "default": -1,
2051 "minimum": -1
2052 },
2053
2054 "rule": {
2055 "description": "A reference used to locate the rule descriptor relevant to this result.",
2056 "$ref": "#/definitions/reportingDescriptorReference"
2057 },
2058
2059 "kind": {
2060 "description": "A value that categorizes results by evaluation state.",
2061 "default": "fail",
2062 "enum": [ "notApplicable", "pass", "fail", "review", "open", "informational" ],
2063 "type": "string"
2064 },
2065
2066 "level": {
2067 "description": "A value specifying the severity level of the result.",
2068 "default": "warning",
2069 "enum": [ "none", "note", "warning", "error" ],
2070 "type": "string"
2071 },
2072
2073 "message": {
2074 "description": "A message that describes the result. The first sentence of the message only will be displayed when visible space is limited.",
2075 "$ref": "#/definitions/message"
2076 },
2077
2078 "analysisTarget": {
2079 "description": "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.",
2080 "$ref": "#/definitions/artifactLocation"
2081 },
2082
2083 "locations": {
2084 "description": "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.",
2085 "type": "array",
2086 "minItems": 0,
2087 "uniqueItems": false,
2088 "default": [],
2089 "items": {
2090 "$ref": "#/definitions/location"
2091 }
2092 },
2093
2094 "guid": {
2095 "description": "A stable, unique identifier for the result in the form of a GUID.",
2096 "type": "string",
2097 "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}$"
2098 },
2099
2100 "correlationGuid": {
2101 "description": "A stable, unique identifier for the equivalence class of logically identical results to which this result belongs, in the form of a GUID.",
2102 "type": "string",
2103 "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}$"
2104 },
2105
2106 "occurrenceCount": {
2107 "description": "A positive integer specifying the number of times this logically unique result was observed in this run.",
2108 "type": "integer",
2109 "minimum": 1
2110 },
2111
2112 "partialFingerprints": {
2113 "description": "A set of strings that contribute to the stable, unique identity of the result.",
2114 "type": "object",
2115 "additionalProperties": {
2116 "type": "string"
2117 }
2118 },
2119
2120 "fingerprints": {
2121 "description": "A set of strings each of which individually defines a stable, unique identity for the result.",
2122 "type": "object",
2123 "additionalProperties": {
2124 "type": "string"
2125 }
2126 },
2127
2128 "stacks": {
2129 "description": "An array of 'stack' objects relevant to the result.",
2130 "type": "array",
2131 "minItems": 0,
2132 "uniqueItems": true,
2133 "default": [],
2134 "items": {
2135 "$ref": "#/definitions/stack"
2136 }
2137 },
2138
2139 "codeFlows": {
2140 "description": "An array of 'codeFlow' objects relevant to the result.",
2141 "type": "array",
2142 "minItems": 0,
2143 "uniqueItems": false,
2144 "default": [],
2145 "items": {
2146 "$ref": "#/definitions/codeFlow"
2147 }
2148 },
2149
2150 "graphs": {
2151 "description": "An array of zero or more unique graph objects associated with the result.",
2152 "type": "array",
2153 "minItems": 0,
2154 "uniqueItems": true,
2155 "default": [],
2156 "items": {
2157 "$ref": "#/definitions/graph"
2158 }
2159 },
2160
2161 "graphTraversals": {
2162 "description": "An array of one or more unique 'graphTraversal' objects.",
2163 "type": "array",
2164 "minItems": 0,
2165 "uniqueItems": true,
2166 "default": [],
2167 "items": {
2168 "$ref": "#/definitions/graphTraversal"
2169 }
2170 },
2171
2172 "relatedLocations": {
2173 "description": "A set of locations relevant to this result.",
2174 "type": "array",
2175 "minItems": 0,
2176 "uniqueItems": true,
2177 "default": [],
2178 "items": {
2179 "$ref": "#/definitions/location"
2180 }
2181 },
2182
2183 "suppressions": {
2184 "description": "A set of suppressions relevant to this result.",
2185 "type": "array",
2186 "minItems": 0,
2187 "uniqueItems": true,
2188 "items": {
2189 "$ref": "#/definitions/suppression"
2190 }
2191 },
2192
2193 "baselineState": {
2194 "description": "The state of a result relative to a baseline of a previous run.",
2195 "enum": [
2196 "new",
2197 "unchanged",
2198 "updated",
2199 "absent"
2200 ],
2201 "type": "string"
2202 },
2203
2204 "rank": {
2205 "description": "A number representing the priority or importance of the result.",
2206 "type": "number",
2207 "default": -1.0,
2208 "minimum": -1.0,
2209 "maximum": 100.0
2210 },
2211
2212 "attachments": {
2213 "description": "A set of artifacts relevant to the result.",
2214 "type": "array",
2215 "minItems": 0,
2216 "uniqueItems": true,
2217 "default": [],
2218 "items": {
2219 "$ref": "#/definitions/attachment"
2220 }
2221 },
2222
2223 "hostedViewerUri": {
2224 "description": "An absolute URI at which the result can be viewed.",
2225 "type": "string",
2226 "format": "uri"
2227 },
2228
2229 "workItemUris": {
2230 "description": "The URIs of the work items associated with this result.",
2231 "type": "array",
2232 "minItems": 0,
2233 "uniqueItems": true,
2234 "items": {
2235 "type": "string",
2236 "format": "uri"
2237 }
2238 },
2239
2240 "provenance": {
2241 "description": "Information about how and when the result was detected.",
2242 "$ref": "#/definitions/resultProvenance"
2243 },
2244
2245 "fixes": {
2246 "description": "An array of 'fix' objects, each of which represents a proposed fix to the problem indicated by the result.",
2247 "type": "array",
2248 "minItems": 0,
2249 "uniqueItems": true,
2250 "default": [],
2251 "items": {
2252 "$ref": "#/definitions/fix"
2253 }
2254 },
2255
2256 "taxa": {
2257 "description": "An array of references to taxonomy reporting descriptors that are applicable to the result.",
2258 "type": "array",
2259 "default": [],
2260 "minItems": 0,
2261 "uniqueItems": true,
2262 "items": {
2263 "$ref": "#/definitions/reportingDescriptorReference"
2264 }
2265 },
2266
2267 "webRequest": {
2268 "description": "A web request associated with this result.",
2269 "$ref": "#/definitions/webRequest"
2270 },
2271
2272 "webResponse": {
2273 "description": "A web response associated with this result.",
2274 "$ref": "#/definitions/webResponse"
2275 },
2276
2277 "properties": {
2278 "description": "Key/value pairs that provide additional information about the result.",
2279 "$ref": "#/definitions/propertyBag"
2280 }
2281 },
2282 "required": [ "message" ]
2283 },
2284
2285 "resultProvenance": {
2286 "description": "Contains information about how and when a result was detected.",
2287 "additionalProperties": false,
2288 "type": "object",
2289 "properties": {
2290
2291 "firstDetectionTimeUtc": {
2292 "description": "The Coordinated Universal Time (UTC) date and time at which the result was first detected. See \"Date/time properties\" in the SARIF spec for the required format.",
2293 "type": "string",
2294 "format": "date-time"
2295 },
2296
2297 "lastDetectionTimeUtc": {
2298 "description": "The Coordinated Universal Time (UTC) date and time at which the result was most recently detected. See \"Date/time properties\" in the SARIF spec for the required format.",
2299 "type": "string",
2300 "format": "date-time"
2301 },
2302
2303 "firstDetectionRunGuid": {
2304 "description": "A GUID-valued string equal to the automationDetails.guid property of the run in which the result was first detected.",
2305 "type": "string",
2306 "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}$"
2307 },
2308
2309 "lastDetectionRunGuid": {
2310 "description": "A GUID-valued string equal to the automationDetails.guid property of the run in which the result was most recently detected.",
2311 "type": "string",
2312 "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}$"
2313 },
2314
2315 "invocationIndex": {
2316 "description": "The index within the run.invocations array of the invocation object which describes the tool invocation that detected the result.",
2317 "type": "integer",
2318 "default": -1,
2319 "minimum": -1
2320 },
2321
2322 "conversionSources": {
2323 "description": "An array of physicalLocation objects which specify the portions of an analysis tool's output that a converter transformed into the result.",
2324 "type": "array",
2325 "minItems": 0,
2326 "uniqueItems": true,
2327 "default": [],
2328 "items": {
2329 "$ref": "#/definitions/physicalLocation"
2330 }
2331 },
2332
2333 "properties": {
2334 "description": "Key/value pairs that provide additional information about the result.",
2335 "$ref": "#/definitions/propertyBag"
2336 }
2337 }
2338 },
2339
2340 "run": {
2341 "description": "Describes a single run of an analysis tool, and contains the reported output of that run.",
2342 "additionalProperties": false,
2343 "type": "object",
2344 "properties": {
2345
2346 "tool": {
2347 "description": "Information about the tool or tool pipeline that generated the results in this run. A run can only contain results produced by a single tool or tool pipeline. A run can aggregate results from multiple log files, as long as context around the tool run (tool command-line arguments and the like) is identical for all aggregated files.",
2348 "$ref": "#/definitions/tool"
2349 },
2350
2351 "invocations": {
2352 "description": "Describes the invocation of the analysis tool.",
2353 "type": "array",
2354 "minItems": 0,
2355 "uniqueItems": false,
2356 "default": [],
2357 "items": {
2358 "$ref": "#/definitions/invocation"
2359 }
2360 },
2361
2362 "conversion": {
2363 "description": "A conversion object that describes how a converter transformed an analysis tool's native reporting format into the SARIF format.",
2364 "$ref": "#/definitions/conversion"
2365 },
2366
2367 "language": {
2368 "description": "The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase culture code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).",
2369 "type": "string",
2370 "default": "en-US",
2371 "pattern": "^[a-zA-Z]{2}(-[a-zA-Z]{2})?$"
2372 },
2373
2374 "versionControlProvenance": {
2375 "description": "Specifies the revision in version control of the artifacts that were scanned.",
2376 "type": "array",
2377 "minItems": 0,
2378 "uniqueItems": true,
2379 "default": [],
2380 "items": {
2381 "$ref": "#/definitions/versionControlDetails"
2382 }
2383 },
2384
2385 "originalUriBaseIds": {
2386 "description": "The artifact location specified by each uriBaseId symbol on the machine where the tool originally ran.",
2387 "type": "object",
2388 "additionalProperties": {
2389 "$ref": "#/definitions/artifactLocation"
2390 }
2391 },
2392
2393 "artifacts": {
2394 "description": "An array of artifact objects relevant to the run.",
2395 "type": "array",
2396 "minItems": 0,
2397 "uniqueItems": true,
2398 "items": {
2399 "$ref": "#/definitions/artifact"
2400 }
2401 },
2402
2403 "logicalLocations": {
2404 "description": "An array of logical locations such as namespaces, types or functions.",
2405 "type": "array",
2406 "minItems": 0,
2407 "uniqueItems": true,
2408 "default": [],
2409 "items": {
2410 "$ref": "#/definitions/logicalLocation"
2411 }
2412 },
2413
2414 "graphs": {
2415 "description": "An array of zero or more unique graph objects associated with the run.",
2416 "type": "array",
2417 "minItems": 0,
2418 "uniqueItems": true,
2419 "default": [],
2420 "items": {
2421 "$ref": "#/definitions/graph"
2422 }
2423 },
2424
2425 "results": {
2426 "description": "The set of results contained in an SARIF log. The results array can be omitted when a run is solely exporting rules metadata. It must be present (but may be empty) if a log file represents an actual scan.",
2427 "type": "array",
2428 "minItems": 0,
2429 "uniqueItems": false,
2430 "items": {
2431 "$ref": "#/definitions/result"
2432 }
2433 },
2434
2435 "automationDetails": {
2436 "description": "Automation details that describe this run.",
2437 "$ref": "#/definitions/runAutomationDetails"
2438 },
2439
2440 "runAggregates": {
2441 "description": "Automation details that describe the aggregate of runs to which this run belongs.",
2442 "type": "array",
2443 "minItems": 0,
2444 "uniqueItems": true,
2445 "default": [],
2446 "items": {
2447 "$ref": "#/definitions/runAutomationDetails"
2448 }
2449 },
2450
2451 "baselineGuid": {
2452 "description": "The 'guid' property of a previous SARIF 'run' that comprises the baseline that was used to compute result 'baselineState' properties for the run.",
2453 "type": "string",
2454 "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}$"
2455 },
2456
2457 "redactionTokens": {
2458 "description": "An array of strings used to replace sensitive information in a redaction-aware property.",
2459 "type": "array",
2460 "minItems": 0,
2461 "uniqueItems": true,
2462 "default": [],
2463 "items": {
2464 "type": "string"
2465 }
2466 },
2467
2468 "defaultEncoding": {
2469 "description": "Specifies the default encoding for any artifact object that refers to a text file.",
2470 "type": "string"
2471 },
2472
2473 "defaultSourceLanguage": {
2474 "description": "Specifies the default source language for any artifact object that refers to a text file that contains source code.",
2475 "type": "string"
2476 },
2477
2478 "newlineSequences": {
2479 "description": "An ordered list of character sequences that were treated as line breaks when computing region information for the run.",
2480 "type": "array",
2481 "minItems": 1,
2482 "uniqueItems": true,
2483 "default": [ "\r\n", "\n" ],
2484 "items": {
2485 "type": "string"
2486 }
2487 },
2488
2489 "columnKind": {
2490 "description": "Specifies the unit in which the tool measures columns.",
2491 "enum": [ "utf16CodeUnits", "unicodeCodePoints" ],
2492 "type": "string"
2493 },
2494
2495 "externalPropertyFileReferences": {
2496 "description": "References to external property files that should be inlined with the content of a root log file.",
2497 "$ref": "#/definitions/externalPropertyFileReferences"
2498 },
2499
2500 "threadFlowLocations": {
2501 "description": "An array of threadFlowLocation objects cached at run level.",
2502 "type": "array",
2503 "minItems": 0,
2504 "uniqueItems": true,
2505 "default": [],
2506 "items": {
2507 "$ref": "#/definitions/threadFlowLocation"
2508 }
2509 },
2510
2511 "taxonomies": {
2512 "description": "An array of toolComponent objects relevant to a taxonomy in which results are categorized.",
2513 "type": "array",
2514 "minItems": 0,
2515 "uniqueItems": true,
2516 "default": [],
2517 "items": {
2518 "$ref": "#/definitions/toolComponent"
2519 }
2520 },
2521
2522 "addresses": {
2523 "description": "Addresses associated with this run instance, if any.",
2524 "type": "array",
2525 "minItems": 0,
2526 "uniqueItems": false,
2527 "default": [],
2528 "items": {
2529 "$ref": "#/definitions/address"
2530 }
2531 },
2532
2533 "translations": {
2534 "description": "The set of available translations of the localized data provided by the tool.",
2535 "type": "array",
2536 "minItems": 0,
2537 "uniqueItems": true,
2538 "default": [],
2539 "items": {
2540 "$ref": "#/definitions/toolComponent"
2541 }
2542 },
2543
2544 "policies": {
2545 "description": "Contains configurations that may potentially override both reportingDescriptor.defaultConfiguration (the tool's default severities) and invocation.configurationOverrides (severities established at run-time from the command line).",
2546 "type": "array",
2547 "minItems": 0,
2548 "uniqueItems": true,
2549 "default": [],
2550 "items": {
2551 "$ref": "#/definitions/toolComponent"
2552 }
2553 },
2554
2555 "webRequests": {
2556 "description": "An array of request objects cached at run level.",
2557 "type": "array",
2558 "minItems": 0,
2559 "uniqueItems": true,
2560 "default": [],
2561 "items": {
2562 "$ref": "#/definitions/webRequest"
2563 }
2564 },
2565
2566 "webResponses": {
2567 "description": "An array of response objects cached at run level.",
2568 "type": "array",
2569 "minItems": 0,
2570 "uniqueItems": true,
2571 "default": [],
2572 "items": {
2573 "$ref": "#/definitions/webResponse"
2574 }
2575 },
2576
2577 "specialLocations": {
2578 "description": "A specialLocations object that defines locations of special significance to SARIF consumers.",
2579 "$ref": "#/definitions/specialLocations"
2580 },
2581
2582 "properties": {
2583 "description": "Key/value pairs that provide additional information about the run.",
2584 "$ref": "#/definitions/propertyBag"
2585 }
2586 },
2587
2588 "required": [ "tool" ]
2589 },
2590
2591 "runAutomationDetails": {
2592 "description": "Information that describes a run's identity and role within an engineering system process.",
2593 "additionalProperties": false,
2594 "type": "object",
2595 "properties": {
2596
2597 "description": {
2598 "description": "A description of the identity and role played within the engineering system by this object's containing run object.",
2599 "$ref": "#/definitions/message"
2600 },
2601
2602 "id": {
2603 "description": "A hierarchical string that uniquely identifies this object's containing run object.",
2604 "type": "string"
2605 },
2606
2607 "guid": {
2608 "description": "A stable, unique identifier for this object's containing run object in the form of a GUID.",
2609 "type": "string",
2610 "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}$"
2611 },
2612
2613 "correlationGuid": {
2614 "description": "A stable, unique identifier for the equivalence class of runs to which this object's containing run object belongs in the form of a GUID.",
2615 "type": "string",
2616 "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}$"
2617 },
2618
2619 "properties": {
2620 "description": "Key/value pairs that provide additional information about the run automation details.",
2621 "$ref": "#/definitions/propertyBag"
2622 }
2623 }
2624 },
2625
2626 "specialLocations": {
2627 "description": "Defines locations of special significance to SARIF consumers.",
2628 "type": "object",
2629 "additionalProperties": false,
2630 "properties": {
2631
2632 "displayBase": {
2633 "description": "Provides a suggestion to SARIF consumers to display file paths relative to the specified location.",
2634 "$ref": "#/definitions/artifactLocation"
2635 },
2636
2637 "properties": {
2638 "description": "Key/value pairs that provide additional information about the special locations.",
2639 "$ref": "#/definitions/propertyBag"
2640 }
2641 }
2642 },
2643
2644 "stack": {
2645 "description": "A call stack that is relevant to a result.",
2646 "additionalProperties": false,
2647 "type": "object",
2648 "properties": {
2649
2650 "message": {
2651 "description": "A message relevant to this call stack.",
2652 "$ref": "#/definitions/message"
2653 },
2654
2655 "frames": {
2656 "description": "An array of stack frames that represents a sequence of calls, rendered in reverse chronological order, that comprise the call stack.",
2657 "type": "array",
2658 "minItems": 0,
2659 "uniqueItems": false,
2660 "items": {
2661 "$ref": "#/definitions/stackFrame"
2662 }
2663 },
2664
2665 "properties": {
2666 "description": "Key/value pairs that provide additional information about the stack.",
2667 "$ref": "#/definitions/propertyBag"
2668 }
2669 },
2670 "required": [ "frames" ]
2671 },
2672
2673 "stackFrame": {
2674 "description": "A function call within a stack trace.",
2675 "additionalProperties": false,
2676 "type": "object",
2677 "properties": {
2678
2679 "location": {
2680 "description": "The location to which this stack frame refers.",
2681 "$ref": "#/definitions/location"
2682 },
2683
2684 "module": {
2685 "description": "The name of the module that contains the code of this stack frame.",
2686 "type": "string"
2687 },
2688
2689 "threadId": {
2690 "description": "The thread identifier of the stack frame.",
2691 "type": "integer"
2692 },
2693
2694 "parameters": {
2695 "description": "The parameters of the call that is executing.",
2696 "type": "array",
2697 "minItems": 0,
2698 "uniqueItems": false,
2699 "default": [],
2700 "items": {
2701 "type": "string",
2702 "default": []
2703 }
2704 },
2705
2706 "properties": {
2707 "description": "Key/value pairs that provide additional information about the stack frame.",
2708 "$ref": "#/definitions/propertyBag"
2709 }
2710 }
2711 },
2712
2713 "suppression": {
2714 "description": "A suppression that is relevant to a result.",
2715 "additionalProperties": false,
2716 "type": "object",
2717 "properties": {
2718
2719 "guid": {
2720 "description": "A stable, unique identifier for the suprression in the form of a GUID.",
2721 "type": "string",
2722 "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}$"
2723 },
2724
2725 "kind": {
2726 "description": "A string that indicates where the suppression is persisted.",
2727 "enum": [
2728 "inSource",
2729 "external"
2730 ],
2731 "type": "string"
2732 },
2733
2734 "status": {
2735 "description": "A string that indicates the review status of the suppression.",
2736 "enum": [
2737 "accepted",
2738 "underReview",
2739 "rejected"
2740 ],
2741 "type": "string"
2742 },
2743
2744 "justification": {
2745 "description": "A string representing the justification for the suppression.",
2746 "type": "string"
2747 },
2748
2749 "location": {
2750 "description": "Identifies the location associated with the suppression.",
2751 "$ref": "#/definitions/location"
2752 },
2753
2754 "properties": {
2755 "description": "Key/value pairs that provide additional information about the suppression.",
2756 "$ref": "#/definitions/propertyBag"
2757 }
2758 },
2759 "required": [ "kind" ]
2760 },
2761
2762 "threadFlow": {
2763 "description": "Describes a sequence of code locations that specify a path through a single thread of execution such as an operating system or fiber.",
2764 "type": "object",
2765 "additionalProperties": false,
2766 "properties": {
2767
2768 "id": {
2769 "description": "An string that uniquely identifies the threadFlow within the codeFlow in which it occurs.",
2770 "type": "string"
2771 },
2772
2773 "message": {
2774 "description": "A message relevant to the thread flow.",
2775 "$ref": "#/definitions/message"
2776 },
2777
2778
2779 "initialState": {
2780 "description": "Values of relevant expressions at the start of the thread flow that may change during thread flow execution.",
2781 "type": "object",
2782 "additionalProperties": {
2783 "$ref": "#/definitions/multiformatMessageString"
2784 }
2785 },
2786
2787 "immutableState": {
2788 "description": "Values of relevant expressions at the start of the thread flow that remain constant.",
2789 "type": "object",
2790 "additionalProperties": {
2791 "$ref": "#/definitions/multiformatMessageString"
2792 }
2793 },
2794
2795 "locations": {
2796 "description": "A temporally ordered array of 'threadFlowLocation' objects, each of which describes a location visited by the tool while producing the result.",
2797 "type": "array",
2798 "minItems": 1,
2799 "uniqueItems": false,
2800 "items": {
2801 "$ref": "#/definitions/threadFlowLocation"
2802 }
2803 },
2804
2805 "properties": {
2806 "description": "Key/value pairs that provide additional information about the thread flow.",
2807 "$ref": "#/definitions/propertyBag"
2808 }
2809 },
2810
2811 "required": [ "locations" ]
2812 },
2813
2814 "threadFlowLocation": {
2815 "description": "A location visited by an analysis tool while simulating or monitoring the execution of a program.",
2816 "additionalProperties": false,
2817 "type": "object",
2818 "properties": {
2819
2820 "index": {
2821 "description": "The index within the run threadFlowLocations array.",
2822 "type": "integer",
2823 "default": -1,
2824 "minimum": -1
2825 },
2826
2827 "location": {
2828 "description": "The code location.",
2829 "$ref": "#/definitions/location"
2830 },
2831
2832 "stack": {
2833 "description": "The call stack leading to this location.",
2834 "$ref": "#/definitions/stack"
2835 },
2836
2837 "kinds": {
2838 "description": "A set of distinct strings that categorize the thread flow location. Well-known kinds include 'acquire', 'release', 'enter', 'exit', 'call', 'return', 'branch', 'implicit', 'false', 'true', 'caution', 'danger', 'unknown', 'unreachable', 'taint', 'function', 'handler', 'lock', 'memory', 'resource', 'scope' and 'value'.",
2839 "type": "array",
2840 "minItems": 0,
2841 "uniqueItems": true,
2842 "default": [],
2843 "items": {
2844 "type": "string"
2845 }
2846 },
2847
2848 "taxa": {
2849 "description": "An array of references to rule or taxonomy reporting descriptors that are applicable to the thread flow location.",
2850 "type": "array",
2851 "default": [],
2852 "minItems": 0,
2853 "uniqueItems": true,
2854 "items": {
2855 "$ref": "#/definitions/reportingDescriptorReference"
2856 }
2857 },
2858
2859 "module": {
2860 "description": "The name of the module that contains the code that is executing.",
2861 "type": "string"
2862 },
2863
2864 "state": {
2865 "description": "A dictionary, each of whose keys specifies a variable or expression, the associated value of which represents the variable or expression value. For an annotation of kind 'continuation', for example, this dictionary might hold the current assumed values of a set of global variables.",
2866 "type": "object",
2867 "additionalProperties": {
2868 "$ref": "#/definitions/multiformatMessageString"
2869 }
2870 },
2871
2872 "nestingLevel": {
2873 "description": "An integer representing a containment hierarchy within the thread flow.",
2874 "type": "integer",
2875 "minimum": 0
2876 },
2877
2878 "executionOrder": {
2879 "description": "An integer representing the temporal order in which execution reached this location.",
2880 "type": "integer",
2881 "default": -1,
2882 "minimum": -1
2883 },
2884
2885 "executionTimeUtc": {
2886 "description": "The Coordinated Universal Time (UTC) date and time at which this location was executed.",
2887 "type": "string",
2888 "format": "date-time"
2889 },
2890
2891 "importance": {
2892 "description": "Specifies the importance of this location in understanding the code flow in which it occurs. The order from most to least important is \"essential\", \"important\", \"unimportant\". Default: \"important\".",
2893 "enum": [ "important", "essential", "unimportant" ],
2894 "default": "important",
2895 "type": "string"
2896 },
2897
2898 "webRequest": {
2899 "description": "A web request associated with this thread flow location.",
2900 "$ref": "#/definitions/webRequest"
2901 },
2902
2903 "webResponse": {
2904 "description": "A web response associated with this thread flow location.",
2905 "$ref": "#/definitions/webResponse"
2906 },
2907
2908 "properties": {
2909 "description": "Key/value pairs that provide additional information about the threadflow location.",
2910 "$ref": "#/definitions/propertyBag"
2911 }
2912 }
2913 },
2914
2915 "tool": {
2916 "description": "The analysis tool that was run.",
2917 "additionalProperties": false,
2918 "type": "object",
2919 "properties": {
2920
2921 "driver": {
2922 "description": "The analysis tool that was run.",
2923 "$ref": "#/definitions/toolComponent"
2924 },
2925
2926 "extensions": {
2927 "description": "Tool extensions that contributed to or reconfigured the analysis tool that was run.",
2928 "type": "array",
2929 "minItems": 0,
2930 "uniqueItems": true,
2931 "default": [],
2932 "items": {
2933 "$ref": "#/definitions/toolComponent"
2934 }
2935 },
2936
2937 "properties": {
2938 "description": "Key/value pairs that provide additional information about the tool.",
2939 "$ref": "#/definitions/propertyBag"
2940 }
2941 },
2942
2943 "required": [ "driver" ]
2944 },
2945
2946 "toolComponent": {
2947 "description": "A component, such as a plug-in or the driver, of the analysis tool that was run.",
2948 "additionalProperties": false,
2949 "type": "object",
2950 "properties": {
2951
2952 "guid": {
2953 "description": "A unique identifier for the tool component in the form of a GUID.",
2954 "type": "string",
2955 "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}$"
2956 },
2957
2958 "name": {
2959 "description": "The name of the tool component.",
2960 "type": "string"
2961 },
2962
2963 "organization": {
2964 "description": "The organization or company that produced the tool component.",
2965 "type": "string"
2966 },
2967
2968 "product": {
2969 "description": "A product suite to which the tool component belongs.",
2970 "type": "string"
2971 },
2972
2973 "productSuite": {
2974 "description": "A localizable string containing the name of the suite of products to which the tool component belongs.",
2975 "type": "string"
2976 },
2977
2978 "shortDescription": {
2979 "description": "A brief description of the tool component.",
2980 "$ref": "#/definitions/multiformatMessageString"
2981 },
2982
2983 "fullDescription": {
2984 "description": "A comprehensive description of the tool component.",
2985 "$ref": "#/definitions/multiformatMessageString"
2986 },
2987
2988 "fullName": {
2989 "description": "The name of the tool component along with its version and any other useful identifying information, such as its locale.",
2990 "type": "string"
2991 },
2992
2993 "version": {
2994 "description": "The tool component version, in whatever format the component natively provides.",
2995 "type": "string"
2996 },
2997
2998 "semanticVersion": {
2999 "description": "The tool component version in the format specified by Semantic Versioning 2.0.",
3000 "type": "string"
3001 },
3002
3003 "dottedQuadFileVersion": {
3004 "description": "The binary version of the tool component's primary executable file expressed as four non-negative integers separated by a period (for operating systems that express file versions in this way).",
3005 "type": "string",
3006 "pattern": "[0-9]+(\\.[0-9]+){3}"
3007 },
3008
3009 "releaseDateUtc": {
3010 "description": "A string specifying the UTC date (and optionally, the time) of the component's release.",
3011 "type": "string"
3012 },
3013
3014 "downloadUri": {
3015 "description": "The absolute URI from which the tool component can be downloaded.",
3016 "type": "string",
3017 "format": "uri"
3018 },
3019
3020 "informationUri": {
3021 "description": "The absolute URI at which information about this version of the tool component can be found.",
3022 "type": "string",
3023 "format": "uri"
3024 },
3025
3026 "globalMessageStrings": {
3027 "description": "A dictionary, each of whose keys is a resource identifier and each of whose values 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.",
3028 "type": "object",
3029 "additionalProperties": {
3030 "$ref": "#/definitions/multiformatMessageString"
3031 }
3032 },
3033
3034 "notifications": {
3035 "description": "An array of reportingDescriptor objects relevant to the notifications related to the configuration and runtime execution of the tool component.",
3036 "type": "array",
3037 "minItems": 0,
3038 "uniqueItems": true,
3039 "default": [],
3040 "items": {
3041 "$ref": "#/definitions/reportingDescriptor"
3042 }
3043 },
3044
3045 "rules": {
3046 "description": "An array of reportingDescriptor objects relevant to the analysis performed by the tool component.",
3047 "type": "array",
3048 "minItems": 0,
3049 "uniqueItems": true,
3050 "default": [],
3051 "items": {
3052 "$ref": "#/definitions/reportingDescriptor"
3053 }
3054 },
3055
3056 "taxa": {
3057 "description": "An array of reportingDescriptor objects relevant to the definitions of both standalone and tool-defined taxonomies.",
3058 "type": "array",
3059 "minItems": 0,
3060 "uniqueItems": true,
3061 "default": [],
3062 "items": {
3063 "$ref": "#/definitions/reportingDescriptor"
3064 }
3065 },
3066
3067 "locations": {
3068 "description": "An array of the artifactLocation objects associated with the tool component.",
3069 "type": "array",
3070 "minItems": 0,
3071 "default": [],
3072 "items": {
3073 "$ref": "#/definitions/artifactLocation"
3074 }
3075 },
3076
3077 "language": {
3078 "description": "The language of the messages emitted into the log file during this run (expressed as an ISO 639-1 two-letter lowercase language code) and an optional region (expressed as an ISO 3166-1 two-letter uppercase subculture code associated with a country or region). The casing is recommended but not required (in order for this data to conform to RFC5646).",
3079 "type": "string",
3080 "default": "en-US",
3081 "pattern": "^[a-zA-Z]{2}(-[a-zA-Z]{2})?$"
3082 },
3083
3084 "contents": {
3085 "description": "The kinds of data contained in this object.",
3086 "type": "array",
3087 "uniqueItems": true,
3088 "default": [ "localizedData", "nonLocalizedData" ],
3089 "items": {
3090 "enum": [
3091 "localizedData",
3092 "nonLocalizedData"
3093 ],
3094 "type": "string"
3095 }
3096 },
3097
3098 "isComprehensive": {
3099 "description": "Specifies whether this object contains a complete definition of the localizable and/or non-localizable data for this component, as opposed to including only data that is relevant to the results persisted to this log file.",
3100 "type": "boolean",
3101 "default": false
3102 },
3103
3104 "localizedDataSemanticVersion": {
3105 "description": "The semantic version of the localized strings defined in this component; maintained by components that provide translations.",
3106 "type": "string"
3107 },
3108
3109 "minimumRequiredLocalizedDataSemanticVersion": {
3110 "description": "The minimum value of localizedDataSemanticVersion required in translations consumed by this component; used by components that consume translations.",
3111 "type": "string"
3112 },
3113
3114 "associatedComponent": {
3115 "description": "The component which is strongly associated with this component. For a translation, this refers to the component which has been translated. For an extension, this is the driver that provides the extension's plugin model.",
3116 "$ref": "#/definitions/toolComponentReference"
3117 },
3118
3119 "translationMetadata": {
3120 "description": "Translation metadata, required for a translation, not populated by other component types.",
3121 "$ref": "#/definitions/translationMetadata"
3122 },
3123
3124 "supportedTaxonomies": {
3125 "description": "An array of toolComponentReference objects to declare the taxonomies supported by the tool component.",
3126 "type": "array",
3127 "minItems": 0,
3128 "uniqueItems": true,
3129 "default": [],
3130 "items": {
3131 "$ref": "#/definitions/toolComponentReference"
3132 }
3133 },
3134
3135 "properties": {
3136 "description": "Key/value pairs that provide additional information about the tool component.",
3137 "$ref": "#/definitions/propertyBag"
3138 }
3139 },
3140
3141 "required": [ "name" ]
3142 },
3143
3144 "toolComponentReference": {
3145 "description": "Identifies a particular toolComponent object, either the driver or an extension.",
3146 "type": "object",
3147 "additionalProperties": false,
3148 "properties": {
3149
3150 "name": {
3151 "description": "The 'name' property of the referenced toolComponent.",
3152 "type": "string"
3153 },
3154
3155 "index": {
3156 "description": "An index into the referenced toolComponent in tool.extensions.",
3157 "type": "integer",
3158 "default": -1,
3159 "minimum": -1
3160 },
3161
3162 "guid": {
3163 "description": "The 'guid' property of the referenced toolComponent.",
3164 "type": "string",
3165 "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}$"
3166 },
3167
3168 "properties": {
3169 "description": "Key/value pairs that provide additional information about the toolComponentReference.",
3170 "$ref": "#/definitions/propertyBag"
3171 }
3172 }
3173 },
3174
3175 "translationMetadata": {
3176 "description": "Provides additional metadata related to translation.",
3177 "type": "object",
3178 "additionalProperties": false,
3179 "properties": {
3180
3181 "name": {
3182 "description": "The name associated with the translation metadata.",
3183 "type": "string"
3184 },
3185
3186 "fullName": {
3187 "description": "The full name associated with the translation metadata.",
3188 "type": "string"
3189 },
3190
3191 "shortDescription": {
3192 "description": "A brief description of the translation metadata.",
3193 "$ref": "#/definitions/multiformatMessageString"
3194 },
3195
3196 "fullDescription": {
3197 "description": "A comprehensive description of the translation metadata.",
3198 "$ref": "#/definitions/multiformatMessageString"
3199 },
3200
3201 "downloadUri": {
3202 "description": "The absolute URI from which the translation metadata can be downloaded.",
3203 "type": "string",
3204 "format": "uri"
3205 },
3206
3207 "informationUri": {
3208 "description": "The absolute URI from which information related to the translation metadata can be downloaded.",
3209 "type": "string",
3210 "format": "uri"
3211 },
3212
3213 "properties": {
3214 "description": "Key/value pairs that provide additional information about the translation metadata.",
3215 "$ref": "#/definitions/propertyBag"
3216 }
3217 },
3218 "required": [ "name" ]
3219 },
3220
3221 "versionControlDetails": {
3222 "description": "Specifies the information necessary to retrieve a desired revision from a version control system.",
3223 "type": "object",
3224 "additionalProperties": false,
3225 "properties": {
3226
3227 "repositoryUri": {
3228 "description": "The absolute URI of the repository.",
3229 "type": "string",
3230 "format": "uri"
3231 },
3232
3233 "revisionId": {
3234 "description": "A string that uniquely and permanently identifies the revision within the repository.",
3235 "type": "string"
3236 },
3237
3238 "branch": {
3239 "description": "The name of a branch containing the revision.",
3240 "type": "string"
3241 },
3242
3243 "revisionTag": {
3244 "description": "A tag that has been applied to the revision.",
3245 "type": "string"
3246 },
3247
3248 "asOfTimeUtc": {
3249 "description": "A Coordinated Universal Time (UTC) date and time that can be used to synchronize an enlistment to the state of the repository at that time.",
3250 "type": "string",
3251 "format": "date-time"
3252 },
3253
3254 "mappedTo": {
3255 "description": "The location in the local file system to which the root of the repository was mapped at the time of the analysis.",
3256 "$ref": "#/definitions/artifactLocation"
3257 },
3258
3259 "properties": {
3260 "description": "Key/value pairs that provide additional information about the version control details.",
3261 "$ref": "#/definitions/propertyBag"
3262 }
3263 },
3264
3265 "required": [ "repositoryUri" ]
3266 },
3267
3268 "webRequest": {
3269 "description": "Describes an HTTP request.",
3270 "type": "object",
3271 "additionalProperties": false,
3272 "properties": {
3273
3274 "index": {
3275 "description": "The index within the run.webRequests array of the request object associated with this result.",
3276 "type": "integer",
3277 "default": -1,
3278 "minimum": -1
3279
3280 },
3281
3282 "protocol": {
3283 "description": "The request protocol. Example: 'http'.",
3284 "type": "string"
3285 },
3286
3287 "version": {
3288 "description": "The request version. Example: '1.1'.",
3289 "type": "string"
3290 },
3291
3292 "target": {
3293 "description": "The target of the request.",
3294 "type": "string"
3295 },
3296
3297 "method": {
3298 "description": "The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.",
3299 "type": "string"
3300 },
3301
3302 "headers": {
3303 "description": "The request headers.",
3304 "type": "object",
3305 "additionalProperties": {
3306 "type": "string"
3307 }
3308 },
3309
3310 "parameters": {
3311 "description": "The request parameters.",
3312 "type": "object",
3313 "additionalProperties": {
3314 "type": "string"
3315 }
3316 },
3317
3318 "body": {
3319 "description": "The body of the request.",
3320 "$ref": "#/definitions/artifactContent"
3321 },
3322
3323 "properties": {
3324 "description": "Key/value pairs that provide additional information about the request.",
3325 "$ref": "#/definitions/propertyBag"
3326 }
3327 }
3328 },
3329
3330 "webResponse": {
3331 "description": "Describes the response to an HTTP request.",
3332 "type": "object",
3333 "additionalProperties": false,
3334 "properties": {
3335
3336 "index": {
3337 "description": "The index within the run.webResponses array of the response object associated with this result.",
3338 "type": "integer",
3339 "default": -1,
3340 "minimum": -1
3341 },
3342
3343 "protocol": {
3344 "description": "The response protocol. Example: 'http'.",
3345 "type": "string"
3346 },
3347
3348 "version": {
3349 "description": "The response version. Example: '1.1'.",
3350 "type": "string"
3351 },
3352
3353 "statusCode": {
3354 "description": "The response status code. Example: 451.",
3355 "type": "integer"
3356 },
3357
3358 "reasonPhrase": {
3359 "description": "The response reason. Example: 'Not found'.",
3360 "type": "string"
3361 },
3362
3363 "headers": {
3364 "description": "The response headers.",
3365 "type": "object",
3366 "additionalProperties": {
3367 "type": "string"
3368 }
3369 },
3370
3371 "body": {
3372 "description": "The body of the response.",
3373 "$ref": "#/definitions/artifactContent"
3374 },
3375
3376 "noResponseReceived": {
3377 "description": "Specifies whether a response was received from the server.",
3378 "type": "boolean",
3379 "default": false
3380 },
3381
3382 "properties": {
3383 "description": "Key/value pairs that provide additional information about the response.",
3384 "$ref": "#/definitions/propertyBag"
3385 }
3386 }
3387 }
3388 }
3389 }