From 12a9d740fc4b19437f56bad44703cf52a6649cc3 Mon Sep 17 00:00:00 2001
From: github-actions <github-actions@users.noreply.github.com>
Date: Mon, 1 Jul 2024 12:28:19 +0000
Subject: [PATCH] Deployed 596627448a5fee7089c199cd6cda968ffe1f7823 with MkDocs

---
 2.0/404.html                                  |   84 +-
 2.0/builder/index.html                        |   86 +-
 2.0/github-code-scanning/index.html           | 1905 -----------------
 2.0/index.html                                |  107 +-
 2.0/installation/index.html                   |   84 +-
 2.0/reference/address/index.html              |   84 +-
 2.0/reference/artifact/index.html             |   84 +-
 2.0/reference/artifactChange/index.html       |   84 +-
 2.0/reference/artifactContent/index.html      |   84 +-
 2.0/reference/attachment/index.html           |   84 +-
 2.0/reference/codeFlow/index.html             |   84 +-
 .../configurationOverride/index.html          |   84 +-
 2.0/reference/conversion/index.html           |   84 +-
 2.0/reference/edge/index.html                 |   84 +-
 2.0/reference/edgeTraversal/index.html        |   84 +-
 2.0/reference/exception/index.html            |   84 +-
 2.0/reference/externalProperties/index.html   |   84 +-
 .../externalPropertyFileReference/index.html  |   84 +-
 .../externalPropertyFileReferences/index.html |   84 +-
 2.0/reference/fix/index.html                  |   84 +-
 2.0/reference/graph/index.html                |   84 +-
 2.0/reference/graphTraversal/index.html       |   84 +-
 2.0/reference/index.html                      |   86 +-
 2.0/reference/invocation/index.html           |   84 +-
 2.0/reference/locationRelationship/index.html |   84 +-
 2.0/reference/logicalLocation/index.html      |   84 +-
 2.0/reference/message/index.html              |   84 +-
 2.0/reference/node/index.html                 |   84 +-
 2.0/reference/notification/index.html         |   84 +-
 2.0/reference/physicalLocation/index.html     |   84 +-
 2.0/reference/rectangle/index.html            |   84 +-
 2.0/reference/replacement/index.html          |   84 +-
 .../reportingConfiguration/index.html         |   84 +-
 2.0/reference/reportingDescriptor/index.html  |   84 +-
 .../reportingDescriptorReference/index.html   |   84 +-
 .../index.html                                |   84 +-
 2.0/reference/result/index.html               |   84 +-
 2.0/reference/resultProvenance/index.html     |   84 +-
 2.0/reference/run/index.html                  |   84 +-
 2.0/reference/runAutomationDetails/index.html |   84 +-
 2.0/reference/sarifLog/index.html             |   84 +-
 2.0/reference/specialLocations/index.html     |   84 +-
 2.0/reference/stack/index.html                |   84 +-
 2.0/reference/stackFrame/index.html           |   84 +-
 2.0/reference/suppression/index.html          |   84 +-
 2.0/reference/threadFlow/index.html           |   84 +-
 2.0/reference/threadFlowLocation/index.html   |   84 +-
 2.0/reference/tool/index.html                 |   84 +-
 .../toolComponentReference/index.html         |   84 +-
 2.0/reference/translationMetadata/index.html  |   84 +-
 .../versionControlDetails/index.html          |   84 +-
 2.0/reference/webRequest/index.html           |   84 +-
 2.0/reference/webResponse/index.html          |   84 +-
 2.0/search/search_index.json                  |    2 +-
 2.0/sitemap.xml                               |    5 -
 2.0/sitemap.xml.gz                            |  Bin 607 -> 593 bytes
 56 files changed, 211 insertions(+), 6096 deletions(-)
 delete mode 100644 2.0/github-code-scanning/index.html

diff --git a/2.0/404.html b/2.0/404.html
index 94f64db..c6b473c 100644
--- a/2.0/404.html
+++ b/2.0/404.html
@@ -261,26 +261,6 @@
   
     
     
-      <li class="md-tabs__item">
-        <a href="/sarif-php-sdk/github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-    
-    
       <li class="md-tabs__item">
         <a href="/sarif-php-sdk/reference/" class="md-tabs__link">
           
@@ -449,62 +429,6 @@
           
         
       
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="/sarif-php-sdk/github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-      
-        
-          
-        
-      
         
       
         
@@ -609,7 +533,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
         
           
           
@@ -625,14 +549,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/builder/index.html b/2.0/builder/index.html
index a0b25b3..4c1727f 100644
--- a/2.0/builder/index.html
+++ b/2.0/builder/index.html
@@ -16,7 +16,7 @@
         <link rel="prev" href="../installation/">
       
       
-        <link rel="next" href="../github-code-scanning/">
+        <link rel="next" href="../reference/">
       
       
       <link rel="icon" href="../assets/images/favicon.png">
@@ -274,26 +274,6 @@
   
     
     
-      <li class="md-tabs__item">
-        <a href="../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-    
-    
       <li class="md-tabs__item">
         <a href="../reference/" class="md-tabs__link">
           
@@ -467,62 +447,6 @@
           
         
       
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-      
-        
-          
-        
-      
         
       
         
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/github-code-scanning/index.html b/2.0/github-code-scanning/index.html
deleted file mode 100644
index f3b0c8d..0000000
--- a/2.0/github-code-scanning/index.html
+++ /dev/null
@@ -1,1905 +0,0 @@
-
-<!doctype html>
-<html lang="en" class="no-js">
-  <head>
-    
-      <meta charset="utf-8">
-      <meta name="viewport" content="width=device-width,initial-scale=1">
-      
-      
-        <meta name="author" content="Laurent Laville">
-      
-      
-        <link rel="canonical" href="https://llaville.github.io/sarif-php-sdk/github-code-scanning/">
-      
-      
-        <link rel="prev" href="../builder/">
-      
-      
-        <link rel="next" href="../reference/">
-      
-      
-      <link rel="icon" href="../assets/images/favicon.png">
-      <meta name="generator" content="mkdocs-1.6.0, mkdocs-material-9.5.27">
-    
-    
-      
-        <title>Index - Sarif PHP SDK</title>
-      
-    
-    
-      <link rel="stylesheet" href="../assets/stylesheets/main.6543a935.min.css">
-      
-        
-        <link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
-      
-      
-
-
-    
-    
-      
-    
-    
-      
-        
-        
-        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
-        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
-        <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
-      
-    
-    
-    <script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
-    
-      
-
-    
-    
-    
-  </head>
-  
-  
-    
-    
-      
-    
-    
-    
-    
-    <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="cyan" data-md-color-accent="indigo">
-  
-    
-    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
-    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
-    <label class="md-overlay" for="__drawer"></label>
-    <div data-md-component="skip">
-      
-        
-        <a href="#github-code-scanning" class="md-skip">
-          Skip to content
-        </a>
-      
-    </div>
-    <div data-md-component="announce">
-      
-    </div>
-    
-    
-      
-
-<header class="md-header" data-md-component="header">
-  <nav class="md-header__inner md-grid" aria-label="Header">
-    <a href=".." title="Sarif PHP SDK" class="md-header__button md-logo" aria-label="Sarif PHP SDK" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
-
-    </a>
-    <label class="md-header__button md-icon" for="__drawer">
-      
-      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
-    </label>
-    <div class="md-header__title" data-md-component="header-title">
-      <div class="md-header__ellipsis">
-        <div class="md-header__topic">
-          <span class="md-ellipsis">
-            Sarif PHP SDK
-          </span>
-        </div>
-        <div class="md-header__topic" data-md-component="header-topic">
-          <span class="md-ellipsis">
-            
-              Index
-            
-          </span>
-        </div>
-      </div>
-    </div>
-    
-      
-        <form class="md-header__option" data-md-component="palette">
-  
-    
-    
-    
-    <input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="cyan" data-md-color-accent="indigo"  aria-label="Switch to dark mode"  type="radio" name="__palette" id="__palette_0">
-    
-      <label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a7 7 0 0 1 7 7c0 2.38-1.19 4.47-3 5.74V17a1 1 0 0 1-1 1H9a1 1 0 0 1-1-1v-2.26C6.19 13.47 5 11.38 5 9a7 7 0 0 1 7-7M9 21v-1h6v1a1 1 0 0 1-1 1h-4a1 1 0 0 1-1-1m3-17a5 5 0 0 0-5 5c0 2.05 1.23 3.81 3 4.58V16h4v-2.42c1.77-.77 3-2.53 3-4.58a5 5 0 0 0-5-5Z"/></svg>
-      </label>
-    
-  
-    
-    
-    
-    <input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo"  aria-label="Switch to light mode"  type="radio" name="__palette" id="__palette_1">
-    
-      <label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a7 7 0 0 0-7 7c0 2.38 1.19 4.47 3 5.74V17a1 1 0 0 0 1 1h6a1 1 0 0 0 1-1v-2.26c1.81-1.27 3-3.36 3-5.74a7 7 0 0 0-7-7M9 21a1 1 0 0 0 1 1h4a1 1 0 0 0 1-1v-1H9v1Z"/></svg>
-      </label>
-    
-  
-</form>
-      
-    
-    
-      <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']"),palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent"));for([key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
-    
-    
-    
-      <label class="md-header__button md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
-      </label>
-      <div class="md-search" data-md-component="search" role="dialog">
-  <label class="md-search__overlay" for="__search"></label>
-  <div class="md-search__inner" role="search">
-    <form class="md-search__form" name="search">
-      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
-      <label class="md-search__icon md-icon" for="__search">
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
-        
-        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
-      </label>
-      <nav class="md-search__options" aria-label="Search">
-        
-        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
-          
-          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
-        </button>
-      </nav>
-      
-    </form>
-    <div class="md-search__output">
-      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
-        <div class="md-search-result" data-md-component="search-result">
-          <div class="md-search-result__meta">
-            Initializing search
-          </div>
-          <ol class="md-search-result__list" role="presentation"></ol>
-        </div>
-      </div>
-    </div>
-  </div>
-</div>
-    
-    
-      <div class="md-header__source">
-        <a href="https://github.com/llaville/sarif-php-sdk" title="Go to repository" class="md-source" data-md-component="source">
-  <div class="md-source__icon md-icon">
-    
-    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
-  </div>
-  <div class="md-source__repository">
-    GitHub
-  </div>
-</a>
-      </div>
-    
-  </nav>
-  
-</header>
-    
-    <div class="md-container" data-md-component="container">
-      
-      
-        
-          
-            
-<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
-  <div class="md-grid">
-    <ul class="md-tabs__list">
-      
-        
-  
-  
-  
-    <li class="md-tabs__item">
-      <a href=".." class="md-tabs__link">
-        
-  
-    
-  
-  Home
-
-      </a>
-    </li>
-  
-
-      
-        
-  
-  
-  
-    <li class="md-tabs__item">
-      <a href="../installation/" class="md-tabs__link">
-        
-  
-    
-  
-  Installation
-
-      </a>
-    </li>
-  
-
-      
-        
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../builder/" class="md-tabs__link">
-          
-  
-    
-  
-  Builder
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-    
-  
-  
-    
-    
-      <li class="md-tabs__item md-tabs__item--active">
-        <a href="./" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../reference/" class="md-tabs__link">
-          
-  
-    
-  
-  Reference
-
-        </a>
-      </li>
-    
-  
-
-      
-    </ul>
-  </div>
-</nav>
-          
-        
-      
-      <main class="md-main" data-md-component="main">
-        <div class="md-main__inner md-grid">
-          
-            
-              
-              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-
-  
-
-
-<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
-  <label class="md-nav__title" for="__drawer">
-    <a href=".." title="Sarif PHP SDK" class="md-nav__button md-logo" aria-label="Sarif PHP SDK" data-md-component="logo">
-      
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
-
-    </a>
-    Sarif PHP SDK
-  </label>
-  
-    <div class="md-nav__source">
-      <a href="https://github.com/llaville/sarif-php-sdk" title="Go to repository" class="md-source" data-md-component="source">
-  <div class="md-source__icon md-icon">
-    
-    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.5.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
-  </div>
-  <div class="md-source__repository">
-    GitHub
-  </div>
-</a>
-    </div>
-  
-  <ul class="md-nav__list" data-md-scrollfix>
-    
-      
-      
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href=".." class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Home
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../installation/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Installation
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../builder/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Builder
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_3">
-            <span class="md-nav__icon md-icon"></span>
-            Builder
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-    
-  
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-        
-        
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="./" class="md-nav__link md-nav__link--active">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-      
-        
-          
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../reference/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Reference
-  </span>
-  
-
-            </a>
-            
-              
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="0">
-                <span class="md-nav__icon md-icon"></span>
-              </label>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_5">
-            <span class="md-nav__icon md-icon"></span>
-            Reference
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/address/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Address
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/artifact/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Artifact
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/artifactChange/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    artifactChange
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/artifactContent/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    artifactContent
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/attachment/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Attachment
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/codeFlow/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    codeFlow
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/configurationOverride/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    configurationOverride
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/conversion/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Conversion
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/edge/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Edge
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/edgeTraversal/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    edgeTraversal
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/exception/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Exception
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/externalProperties/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    externalProperties
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/externalPropertyFileReference/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    externalPropertyFileReference
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/externalPropertyFileReferences/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    externalPropertyFileReferences
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/fix/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Fix
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/graph/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Graph
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/graphTraversal/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    graphTraversal
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/invocation/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Invocation
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/locationRelationship/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    locationRelationship
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/logicalLocation/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    logicalLocation
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/message/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Message
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/node/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Node
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/notification/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Notification
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/physicalLocation/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    physicalLocation
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/rectangle/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Rectangle
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/replacement/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Replacement
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/reportingConfiguration/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    reportingConfiguration
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/reportingDescriptor/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    reportingDescriptor
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/reportingDescriptorReference/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    reportingDescriptorReference
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/reportingDescriptorRelationship/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    reportingDescriptorRelationship
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/result/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Result
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/resultProvenance/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    resultProvenance
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/run/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Run
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/runAutomationDetails/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    runAutomationDetails
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/sarifLog/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    sarifLog
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/specialLocations/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    specialLocations
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/stack/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Stack
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/stackFrame/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    stackFrame
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/suppression/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Suppression
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/threadFlow/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    threadFlow
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/threadFlowLocation/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    threadFlowLocation
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/tool/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    Tool
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/toolComponentReference/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    toolComponentReference
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/translationMetadata/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    translationMetadata
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/versionControlDetails/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    versionControlDetails
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/webRequest/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    webRequest
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-              
-                
-  
-  
-  
-  
-    <li class="md-nav__item">
-      <a href="../reference/webResponse/" class="md-nav__link">
-        
-  
-  <span class="md-ellipsis">
-    webResponse
-  </span>
-  
-
-      </a>
-    </li>
-  
-
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-  </ul>
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-            
-              
-              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
-                <div class="md-sidebar__scrollwrap">
-                  <div class="md-sidebar__inner">
-                    
-
-<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
-  
-  
-  
-    
-  
-  
-    <label class="md-nav__title" for="__toc">
-      <span class="md-nav__icon md-icon"></span>
-      Table of contents
-    </label>
-    <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
-      
-        <li class="md-nav__item">
-  <a href="#php_codesniffer" class="md-nav__link">
-    <span class="md-ellipsis">
-      PHP_CodeSniffer
-    </span>
-  </a>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#phplint" class="md-nav__link">
-    <span class="md-ellipsis">
-      PHPLint
-    </span>
-  </a>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#phpstan" class="md-nav__link">
-    <span class="md-ellipsis">
-      PHPStan
-    </span>
-  </a>
-  
-</li>
-      
-    </ul>
-  
-</nav>
-                  </div>
-                </div>
-              </div>
-            
-          
-          
-            <div class="md-content" data-md-component="content">
-              <article class="md-content__inner md-typeset">
-                
-                  
-
-
-<!-- markdownlint-disable MD013 -->
-<h1 id="github-code-scanning">GitHub Code Scanning</h1>
-<blockquote>
-<p>You can use code scanning to find security vulnerabilities and errors in the code for your project on GitHub.
-Learn more on official <a href="https://docs.github.com/en/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning">GitHub documentation</a></p>
-</blockquote>
-<p>GitHub Code Scanning features are compatible with SARIF.</p>
-<blockquote>
-<p>[!NOTE]
-Since version 1.2.0</p>
-<ol>
-<li>The SARIF converter for PHP_CodeSniffer allows you to use <a href="https://github.com/PHPCSStandards/PHP_CodeSniffer/">PHP_CodeSniffer</a> as GitHub Code Scanning tool.</li>
-<li>The SARIF converter for PHPLint allows you to use <a href="https://github.com/overtrue/phplint">PHPLint</a> as GitHub Code Scanning tool.</li>
-<li>The SARIF converter for PHPStan allows you to use <a href="https://github.com/phpstan/phpstan">PHPStan</a> as GitHub Code Scanning tool.</li>
-</ol>
-</blockquote>
-<p>Don't forget to add enough permissions in your jobs :</p>
-<div class="highlight"><pre><span></span><code><span class="w">    </span><span class="nt">permissions</span><span class="p">:</span>
-<span class="w">        </span><span class="c1"># required for all workflows</span>
-<span class="w">        </span><span class="nt">security-events</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">write</span>
-<span class="w">        </span><span class="c1"># only required for workflows in private repositories</span>
-<span class="w">        </span><span class="nt">actions</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">read</span>
-<span class="w">        </span><span class="nt">contents</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">read</span>
-</code></pre></div>
-<p>And <a href="https://docs.github.com/en/code-security/code-scanning/enabling-code-scanning">enable CodeQL</a> in your repository :</p>
-<ul>
-<li>Follows <a href="https://docs.github.com/en/code-security/code-scanning/enabling-code-scanning/configuring-default-setup-for-code-scanning">configuring default setup for code scanning</a> steps.</li>
-</ul>
-<blockquote>
-<p>[!NOTE]
-Use <a href="https://github.com/github/codeql-action">codeql-action</a> for running CodeQL analysis.</p>
-</blockquote>
-<p>You can upload SARIF files generated outside GitHub and see code scanning alerts from third-party tools in your repository.</p>
-<p>Learn more, and see how to <a href="https://docs.github.com/en/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github">Upload a SARIF file to GitHub</a>.</p>
-<h2 id="php_codesniffer">PHP_CodeSniffer</h2>
-<p>To use in one of your GitHub Actions workflows, add the following in your job:</p>
-<div class="highlight"><pre><span></span><code><span class="nt">jobs</span><span class="p">:</span>
-<span class="w">    </span><span class="nt">phpcs-analysis</span><span class="p">:</span>
-<span class="w">        </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PHPCS analysis</span>
-
-<span class="w">        </span><span class="nt">steps</span><span class="p">:</span>
-<span class="w">            </span><span class="p p-Indicator">-</span><span class="w">   </span><span class="c1"># https://github.com/llaville/sarif-php-sdk/tree/master/examples/converters/phpcs</span>
-<span class="w">                </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Install PHPCS SARIF Converter</span>
-<span class="w">                </span><span class="nt">run</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">composer require --dev --prefer-dist --no-progress squizlabs/php_codesniffer bartlett/sarif-php-sdk</span>
-
-<span class="w">            </span><span class="p p-Indicator">-</span><span class="w">   </span><span class="c1"># https://github.com/PHPCSStandards/PHP_CodeSniffer</span>
-<span class="w">                </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Run PHPCS analysis</span>
-<span class="w">                </span><span class="nt">continue-on-error</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
-<span class="w">                </span><span class="nt">run</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vendor/bin/phpcs --report=&#39;\Bartlett\Sarif\Converter\PhpCsConverter&#39; --report-file=phpcs.sarif.json</span>
-
-<span class="w">            </span><span class="p p-Indicator">-</span><span class="w">   </span><span class="c1"># https://github.com/github/codeql-action</span>
-<span class="w">                </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Upload analysis results to GitHub</span>
-<span class="w">                </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github/codeql-action/upload-sarif@v3</span>
-<span class="w">                </span><span class="nt">with</span><span class="p">:</span>
-<span class="w">                    </span><span class="nt">sarif_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">phpcs.sarif.json</span>
-<span class="w">                    </span><span class="nt">wait-for-processing</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
-</code></pre></div>
-<blockquote>
-<p>[!WARNING]
-Be sure to have a PHPCS xml config file that declare a sufficient autoloader.</p>
-</blockquote>
-<p>See full <a href="https://github.com/llaville/sarif-php-sdk/blob/1.3/.github/workflows/codeql.yml#L19">CodeQL analysis</a> job.</p>
-<h2 id="phplint">PHPLint</h2>
-<p>To use in one of your GitHub Actions workflows, add the following in your job:</p>
-<div class="highlight"><pre><span></span><code><span class="nt">jobs</span><span class="p">:</span>
-<span class="w">    </span><span class="nt">phplint-analysis</span><span class="p">:</span>
-<span class="w">        </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PHPLint analysis</span>
-
-<span class="w">        </span><span class="nt">steps</span><span class="p">:</span>
-<span class="w">            </span><span class="p p-Indicator">-</span><span class="w">   </span><span class="c1"># https://github.com/llaville/sarif-php-sdk/tree/master/examples/converters/phplint</span>
-<span class="w">                </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Install PHPLint SARIF Converter</span>
-<span class="w">                </span><span class="nt">run</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">composer require --dev --prefer-dist --no-progress overtrue/phplint bartlett/sarif-php-sdk</span>
-
-<span class="w">            </span><span class="p p-Indicator">-</span><span class="w">   </span><span class="c1"># https://github.com/overtrue/phplint</span>
-<span class="w">                </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Run PHPLint analysis</span>
-<span class="w">                </span><span class="nt">continue-on-error</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
-<span class="w">                </span><span class="nt">run</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vendor/bin/phplint --log-sarif=phplint.sarif.json --bootstrap autoload.php</span>
-
-<span class="w">            </span><span class="p p-Indicator">-</span><span class="w">   </span><span class="c1"># https://github.com/github/codeql-action</span>
-<span class="w">                </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Upload analysis results to GitHub</span>
-<span class="w">                </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github/codeql-action/upload-sarif@v3</span>
-<span class="w">                </span><span class="nt">with</span><span class="p">:</span>
-<span class="w">                    </span><span class="nt">sarif_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">phplint.sarif.json</span>
-<span class="w">                    </span><span class="nt">wait-for-processing</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
-</code></pre></div>
-<blockquote>
-<p>[!WARNING]
-Be sure to have a sufficient autoloader (<code>bootstrap</code> option), especially if you customize your SARIF converter.</p>
-</blockquote>
-<p>See full <a href="https://github.com/llaville/sarif-php-sdk/blob/1.3/.github/workflows/codeql.yml#L82">CodeQL analysis</a> job.</p>
-<h2 id="phpstan">PHPStan</h2>
-<p>To use in one of your GitHub Actions workflows, add the following in your job:</p>
-<div class="highlight"><pre><span></span><code><span class="nt">jobs</span><span class="p">:</span>
-<span class="w">    </span><span class="nt">phpstan-analysis</span><span class="p">:</span>
-<span class="w">        </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">PHPStan analysis</span>
-
-<span class="w">        </span><span class="nt">steps</span><span class="p">:</span>
-<span class="w">            </span><span class="p p-Indicator">-</span><span class="w">   </span><span class="c1"># https://github.com/llaville/sarif-php-sdk/tree/master/examples/converters/phpstan</span>
-<span class="w">              </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Install PHPStan SARIF Converter</span>
-<span class="w">              </span><span class="nt">run</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">composer require --dev --prefer-dist --no-progress phpstan/phpstan bartlett/sarif-php-sdk</span>
-
-<span class="w">            </span><span class="p p-Indicator">-</span><span class="w">   </span><span class="c1"># https://github.com/phpstan/phpstan</span>
-<span class="w">              </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Run PHPStan analysis</span>
-<span class="w">              </span><span class="nt">continue-on-error</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
-<span class="w">              </span><span class="nt">run</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">vendor/bin/phpstan analyze --configuration=phpstan.neon.dist --error-format=sarif --autoload-file vendor/autoload.php &gt; phpstan.sarif.json</span>
-
-<span class="w">            </span><span class="p p-Indicator">-</span><span class="w">   </span><span class="c1"># https://github.com/github/codeql-action</span>
-<span class="w">              </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Upload analysis results to GitHub</span>
-<span class="w">              </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">github/codeql-action/upload-sarif@v3</span>
-<span class="w">              </span><span class="nt">with</span><span class="p">:</span>
-<span class="w">                  </span><span class="nt">sarif_file</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">phpstan.sarif.json</span>
-<span class="w">                  </span><span class="nt">wait-for-processing</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span>
-</code></pre></div>
-<blockquote>
-<p>[!WARNING]
-Be sure to have a sufficient neon config file that defined the SARIF formatter to use.</p>
-</blockquote>
-<p>E.g with default converter :</p>
-<div class="highlight"><pre><span></span><code><span class="nt">services</span><span class="p">:</span>
-<span class="w">    </span><span class="nt">errorFormatter.sarif</span><span class="p">:</span>
-<span class="w">        </span><span class="nt">class</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Bartlett\Sarif\Converter\PhpStanConverter</span>
-</code></pre></div>
-<p>See full <a href="https://github.com/llaville/sarif-php-sdk/blob/1.3/.github/workflows/codeql.yml#L145">CodeQL analysis</a> job.</p>
-
-
-
-
-
-
-
-
-
-
-
-
-                
-              </article>
-            </div>
-          
-          
-<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
-        </div>
-        
-          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
-  
-  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z"/></svg>
-  Back to top
-</button>
-        
-      </main>
-      
-        <footer class="md-footer">
-  
-  <div class="md-footer-meta md-typeset">
-    <div class="md-footer-meta__inner md-grid">
-      <div class="md-copyright">
-  
-  
-    Made with
-    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
-      Material for MkDocs
-    </a>
-  
-</div>
-      
-    </div>
-  </div>
-</footer>
-      
-    </div>
-    <div class="md-dialog" data-md-component="dialog">
-      <div class="md-dialog__inner md-typeset"></div>
-    </div>
-    
-    
-    <script id="__config" type="application/json">{"base": "..", "features": ["navigation.instant", "navigation.tabs", "navigation.indexes", "navigation.top"], "search": "../assets/javascripts/workers/search.b8dbb3d2.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
-    
-    
-      <script src="../assets/javascripts/bundle.ad660dcc.min.js"></script>
-      
-    
-  </body>
-</html>
\ No newline at end of file
diff --git a/2.0/index.html b/2.0/index.html
index 13cc6e8..5d2e216 100644
--- a/2.0/index.html
+++ b/2.0/index.html
@@ -272,26 +272,6 @@
   
     
     
-      <li class="md-tabs__item">
-        <a href="github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-    
-    
       <li class="md-tabs__item">
         <a href="reference/" class="md-tabs__link">
           
@@ -428,15 +408,6 @@
     </span>
   </a>
   
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#github-code-scanning" class="md-nav__link">
-    <span class="md-ellipsis">
-      GitHub Code Scanning
-    </span>
-  </a>
-  
 </li>
       
     </ul>
@@ -536,62 +507,6 @@
           
         
       
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-      
-        
-          
-        
-      
         
       
         
@@ -696,7 +611,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
         
           
           
@@ -712,14 +627,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
@@ -1772,15 +1687,6 @@
     </span>
   </a>
   
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#github-code-scanning" class="md-nav__link">
-    <span class="md-ellipsis">
-      GitHub Code Scanning
-    </span>
-  </a>
-  
 </li>
       
     </ul>
@@ -1820,11 +1726,6 @@ <h2 id="api-builders">API Builders</h2>
 <p>Discover all fluent builders with each one at least an example of how to generate a SARIF report.</p>
 </blockquote>
 <p>See <a href="builder/">Builder Guide</a></p>
-<h2 id="github-code-scanning">GitHub Code Scanning</h2>
-<blockquote>
-<p>Discover how to integrate SARIF reports with GH Code Scanning features.</p>
-</blockquote>
-<p>See <a href="github-code-scanning/">GitHub Code Scanning Guide</a></p>
 
 
 
diff --git a/2.0/installation/index.html b/2.0/installation/index.html
index a097f7c..6130a88 100644
--- a/2.0/installation/index.html
+++ b/2.0/installation/index.html
@@ -274,26 +274,6 @@
   
     
     
-      <li class="md-tabs__item">
-        <a href="../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
-  
-    
-    
       <li class="md-tabs__item">
         <a href="../reference/" class="md-tabs__link">
           
@@ -547,62 +527,6 @@
           
         
       
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
-  
-  
-    
-    
-      
-        
-          
-        
-      
         
       
         
@@ -707,7 +631,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
         
           
           
@@ -723,14 +647,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="0">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/address/index.html b/2.0/reference/address/index.html
index 5ff8053..f4d0bc4 100644
--- a/2.0/reference/address/index.html
+++ b/2.0/reference/address/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/artifact/index.html b/2.0/reference/artifact/index.html
index e42699a..7e92ada 100644
--- a/2.0/reference/artifact/index.html
+++ b/2.0/reference/artifact/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/artifactChange/index.html b/2.0/reference/artifactChange/index.html
index 480c596..e53b24b 100644
--- a/2.0/reference/artifactChange/index.html
+++ b/2.0/reference/artifactChange/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/artifactContent/index.html b/2.0/reference/artifactContent/index.html
index f8b0d54..32ec739 100644
--- a/2.0/reference/artifactContent/index.html
+++ b/2.0/reference/artifactContent/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/attachment/index.html b/2.0/reference/attachment/index.html
index e6b212e..56f6026 100644
--- a/2.0/reference/attachment/index.html
+++ b/2.0/reference/attachment/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/codeFlow/index.html b/2.0/reference/codeFlow/index.html
index 894f951..3f856a9 100644
--- a/2.0/reference/codeFlow/index.html
+++ b/2.0/reference/codeFlow/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/configurationOverride/index.html b/2.0/reference/configurationOverride/index.html
index 54875ec..2d4018e 100644
--- a/2.0/reference/configurationOverride/index.html
+++ b/2.0/reference/configurationOverride/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/conversion/index.html b/2.0/reference/conversion/index.html
index 3e9254c..93cf4ce 100644
--- a/2.0/reference/conversion/index.html
+++ b/2.0/reference/conversion/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/edge/index.html b/2.0/reference/edge/index.html
index 561714f..3fa1cfd 100644
--- a/2.0/reference/edge/index.html
+++ b/2.0/reference/edge/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/edgeTraversal/index.html b/2.0/reference/edgeTraversal/index.html
index fb52027..f42d36c 100644
--- a/2.0/reference/edgeTraversal/index.html
+++ b/2.0/reference/edgeTraversal/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/exception/index.html b/2.0/reference/exception/index.html
index 0f0ec9d..48a4755 100644
--- a/2.0/reference/exception/index.html
+++ b/2.0/reference/exception/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/externalProperties/index.html b/2.0/reference/externalProperties/index.html
index 046bbe1..bd97179 100644
--- a/2.0/reference/externalProperties/index.html
+++ b/2.0/reference/externalProperties/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/externalPropertyFileReference/index.html b/2.0/reference/externalPropertyFileReference/index.html
index c5f284f..a96ef6a 100644
--- a/2.0/reference/externalPropertyFileReference/index.html
+++ b/2.0/reference/externalPropertyFileReference/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/externalPropertyFileReferences/index.html b/2.0/reference/externalPropertyFileReferences/index.html
index f9cc8dc..7d4b292 100644
--- a/2.0/reference/externalPropertyFileReferences/index.html
+++ b/2.0/reference/externalPropertyFileReferences/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/fix/index.html b/2.0/reference/fix/index.html
index cf324b6..ebcfd52 100644
--- a/2.0/reference/fix/index.html
+++ b/2.0/reference/fix/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/graph/index.html b/2.0/reference/graph/index.html
index 0f4420b..4da4f21 100644
--- a/2.0/reference/graph/index.html
+++ b/2.0/reference/graph/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/graphTraversal/index.html b/2.0/reference/graphTraversal/index.html
index 5048259..1bd2620 100644
--- a/2.0/reference/graphTraversal/index.html
+++ b/2.0/reference/graphTraversal/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/index.html b/2.0/reference/index.html
index d2c6a3b..38f4b32 100644
--- a/2.0/reference/index.html
+++ b/2.0/reference/index.html
@@ -13,7 +13,7 @@
         <link rel="canonical" href="https://llaville.github.io/sarif-php-sdk/reference/">
       
       
-        <link rel="prev" href="../github-code-scanning/">
+        <link rel="prev" href="../builder/">
       
       
         <link rel="next" href="address/">
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link md-nav__link--active" for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link md-nav__link--active" for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/invocation/index.html b/2.0/reference/invocation/index.html
index d2f7cd8..955e238 100644
--- a/2.0/reference/invocation/index.html
+++ b/2.0/reference/invocation/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/locationRelationship/index.html b/2.0/reference/locationRelationship/index.html
index c950248..b7265f0 100644
--- a/2.0/reference/locationRelationship/index.html
+++ b/2.0/reference/locationRelationship/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/logicalLocation/index.html b/2.0/reference/logicalLocation/index.html
index f07e449..d1d776c 100644
--- a/2.0/reference/logicalLocation/index.html
+++ b/2.0/reference/logicalLocation/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/message/index.html b/2.0/reference/message/index.html
index 25e9768..b3ffaba 100644
--- a/2.0/reference/message/index.html
+++ b/2.0/reference/message/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/node/index.html b/2.0/reference/node/index.html
index c818afd..8420b37 100644
--- a/2.0/reference/node/index.html
+++ b/2.0/reference/node/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/notification/index.html b/2.0/reference/notification/index.html
index c5f7ae2..97e1ca6 100644
--- a/2.0/reference/notification/index.html
+++ b/2.0/reference/notification/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/physicalLocation/index.html b/2.0/reference/physicalLocation/index.html
index 1fc89eb..cce309f 100644
--- a/2.0/reference/physicalLocation/index.html
+++ b/2.0/reference/physicalLocation/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/rectangle/index.html b/2.0/reference/rectangle/index.html
index fbd7f89..8f44f26 100644
--- a/2.0/reference/rectangle/index.html
+++ b/2.0/reference/rectangle/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/replacement/index.html b/2.0/reference/replacement/index.html
index e4e5650..4e7249b 100644
--- a/2.0/reference/replacement/index.html
+++ b/2.0/reference/replacement/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/reportingConfiguration/index.html b/2.0/reference/reportingConfiguration/index.html
index af201e7..abfee7f 100644
--- a/2.0/reference/reportingConfiguration/index.html
+++ b/2.0/reference/reportingConfiguration/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/reportingDescriptor/index.html b/2.0/reference/reportingDescriptor/index.html
index 4ad1d76..f80cb68 100644
--- a/2.0/reference/reportingDescriptor/index.html
+++ b/2.0/reference/reportingDescriptor/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/reportingDescriptorReference/index.html b/2.0/reference/reportingDescriptorReference/index.html
index 359c1d3..9606054 100644
--- a/2.0/reference/reportingDescriptorReference/index.html
+++ b/2.0/reference/reportingDescriptorReference/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/reportingDescriptorRelationship/index.html b/2.0/reference/reportingDescriptorRelationship/index.html
index 2be0bfb..722ec52 100644
--- a/2.0/reference/reportingDescriptorRelationship/index.html
+++ b/2.0/reference/reportingDescriptorRelationship/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/result/index.html b/2.0/reference/result/index.html
index 3d1d231..939f30d 100644
--- a/2.0/reference/result/index.html
+++ b/2.0/reference/result/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/resultProvenance/index.html b/2.0/reference/resultProvenance/index.html
index 86ca8f0..41bfc89 100644
--- a/2.0/reference/resultProvenance/index.html
+++ b/2.0/reference/resultProvenance/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/run/index.html b/2.0/reference/run/index.html
index cb61454..b9e6702 100644
--- a/2.0/reference/run/index.html
+++ b/2.0/reference/run/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/runAutomationDetails/index.html b/2.0/reference/runAutomationDetails/index.html
index b90b1e8..71fc42e 100644
--- a/2.0/reference/runAutomationDetails/index.html
+++ b/2.0/reference/runAutomationDetails/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/sarifLog/index.html b/2.0/reference/sarifLog/index.html
index 84ad2de..9281cca 100644
--- a/2.0/reference/sarifLog/index.html
+++ b/2.0/reference/sarifLog/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/specialLocations/index.html b/2.0/reference/specialLocations/index.html
index d47f183..4a54f4d 100644
--- a/2.0/reference/specialLocations/index.html
+++ b/2.0/reference/specialLocations/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/stack/index.html b/2.0/reference/stack/index.html
index b9f31d5..571d53a 100644
--- a/2.0/reference/stack/index.html
+++ b/2.0/reference/stack/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/stackFrame/index.html b/2.0/reference/stackFrame/index.html
index e115ac1..232cd08 100644
--- a/2.0/reference/stackFrame/index.html
+++ b/2.0/reference/stackFrame/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/suppression/index.html b/2.0/reference/suppression/index.html
index a31ea07..f6a7828 100644
--- a/2.0/reference/suppression/index.html
+++ b/2.0/reference/suppression/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/threadFlow/index.html b/2.0/reference/threadFlow/index.html
index 35e7487..047f70f 100644
--- a/2.0/reference/threadFlow/index.html
+++ b/2.0/reference/threadFlow/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/threadFlowLocation/index.html b/2.0/reference/threadFlowLocation/index.html
index 900dee8..0eca9ad 100644
--- a/2.0/reference/threadFlowLocation/index.html
+++ b/2.0/reference/threadFlowLocation/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/tool/index.html b/2.0/reference/tool/index.html
index f850501..5b666dd 100644
--- a/2.0/reference/tool/index.html
+++ b/2.0/reference/tool/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/toolComponentReference/index.html b/2.0/reference/toolComponentReference/index.html
index 518191c..708c06a 100644
--- a/2.0/reference/toolComponentReference/index.html
+++ b/2.0/reference/toolComponentReference/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/translationMetadata/index.html b/2.0/reference/translationMetadata/index.html
index 30352b2..edc9401 100644
--- a/2.0/reference/translationMetadata/index.html
+++ b/2.0/reference/translationMetadata/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/versionControlDetails/index.html b/2.0/reference/versionControlDetails/index.html
index 4561177..53dc498 100644
--- a/2.0/reference/versionControlDetails/index.html
+++ b/2.0/reference/versionControlDetails/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/webRequest/index.html b/2.0/reference/webRequest/index.html
index bfa3171..7d06843 100644
--- a/2.0/reference/webRequest/index.html
+++ b/2.0/reference/webRequest/index.html
@@ -269,26 +269,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -453,62 +433,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -627,7 +551,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -643,14 +567,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/reference/webResponse/index.html b/2.0/reference/webResponse/index.html
index 817fcd0..4002cd0 100644
--- a/2.0/reference/webResponse/index.html
+++ b/2.0/reference/webResponse/index.html
@@ -267,26 +267,6 @@
         
   
   
-  
-    
-    
-      <li class="md-tabs__item">
-        <a href="../../github-code-scanning/" class="md-tabs__link">
-          
-  
-    
-  
-  Github code scanning
-
-        </a>
-      </li>
-    
-  
-
-      
-        
-  
-  
     
   
   
@@ -451,62 +431,6 @@
       
   
   
-  
-  
-    
-    
-      
-        
-          
-        
-      
-    
-    
-      
-      
-    
-    
-    <li class="md-nav__item md-nav__item--nested">
-      
-        
-        
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
-        
-          
-          
-          <div class="md-nav__link md-nav__container">
-            <a href="../../github-code-scanning/" class="md-nav__link ">
-              
-  
-  <span class="md-ellipsis">
-    Github code scanning
-  </span>
-  
-
-            </a>
-            
-          </div>
-        
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
-          <label class="md-nav__title" for="__nav_4">
-            <span class="md-nav__icon md-icon"></span>
-            Github code scanning
-          </label>
-          <ul class="md-nav__list" data-md-scrollfix>
-            
-              
-            
-          </ul>
-        </nav>
-      
-    </li>
-  
-
-    
-      
-      
-  
-  
     
   
   
@@ -625,7 +549,7 @@
       
         
         
-        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" checked>
+        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
         
           
           
@@ -641,14 +565,14 @@
             </a>
             
               
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
                 <span class="md-nav__icon md-icon"></span>
               </label>
             
           </div>
         
-        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="true">
-          <label class="md-nav__title" for="__nav_5">
+        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
+          <label class="md-nav__title" for="__nav_4">
             <span class="md-nav__icon md-icon"></span>
             Reference
           </label>
diff --git a/2.0/search/search_index.json b/2.0/search/search_index.json
index c36e52b..ee9fc20 100644
--- a/2.0/search/search_index.json
+++ b/2.0/search/search_index.json
@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":""},{"location":"#about","title":"About","text":"<p>This PHP SDK produces the SARIF output, which is a JSON file formatted in accordance with the latest specification. This implementation follows the general format rules but also specifies several custom properties written in property bags.</p> <p></p>"},{"location":"#installation","title":"Installation","text":"<p>Learn how to install this library in different way.</p> <p>See Installation Guide</p>"},{"location":"#api-reference","title":"API Reference","text":"<p>Discover all API objects with each one at least an example of how to generate a SARIF report.</p> <p>See Reference Guide</p>"},{"location":"#api-builders","title":"API Builders","text":"<p>Discover all fluent builders with each one at least an example of how to generate a SARIF report.</p> <p>See Builder Guide</p>"},{"location":"#github-code-scanning","title":"GitHub Code Scanning","text":"<p>Discover how to integrate SARIF reports with GH Code Scanning features.</p> <p>See GitHub Code Scanning Guide</p>"},{"location":"installation/","title":"Installation","text":""},{"location":"installation/#installation","title":"Installation","text":"<ol> <li>Requirements</li> <li>PHAR</li> <li>Phive</li> <li>Composer</li> <li>Git</li> </ol>"},{"location":"installation/#requirements","title":"Requirements","text":"<ul> <li>PHP 7.4 or greater</li> <li>ext-json</li> <li>ext-pcre</li> <li>ext-spl</li> </ul>"},{"location":"installation/#phar","title":"PHAR","text":"<p>The preferred method of installation is to use the PHAR version which can be downloaded from the most recent Github Release. This method ensures you will not have any dependency conflict issue.</p> <p>[!TIP] When you want to use, load autoloader as follows :</p> <pre><code>require_once 'phar://' . '/absolute/path/to' . '/sarif-php-sdk.phar/vendor/autoload.php';\n</code></pre>"},{"location":"installation/#phive","title":"Phive","text":"<p>You can install application globally with Phive</p> <pre><code>phive install llaville/sarif-php-sdk --force-accept-unsigned\n</code></pre> <p>To upgrade global installation of the application use the following command:</p> <pre><code>phive update llaville/sarif-php-sdk --force-accept-unsigned\n</code></pre> <p>You can also install application locally to your project with Phive and configuration file <code>.phive/phars.xml</code></p> <pre><code>&lt;?xml version=\"1.0\" encoding=\"UTF-8\"?&gt;\n&lt;phive xmlns=\"https://phar.io/phive\"&gt;\n    &lt;phar name=\"llaville/sarif-php-sdk\" version=\"^1.3\" copy=\"false\" /&gt;\n&lt;/phive&gt;\n</code></pre> <pre><code>phive install --force-accept-unsigned\n</code></pre>"},{"location":"installation/#composer","title":"Composer","text":"<p>The recommended way to install this library is through composer. If you don't know yet what is composer, have a look on introduction.</p> <pre><code>composer require bartlett/sarif-php-sdk ^1.3\n</code></pre> <p>If you cannot install it because of a dependency conflict, or you prefer to install it for your project, we recommend you to take a look at bamarni/composer-bin-plugin. Example:</p> <pre><code>composer require --dev bamarni/composer-bin-plugin\ncomposer bin sarif-php-sdk require --dev bartlett/sarif-php-sdk\n</code></pre>"},{"location":"installation/#git","title":"Git","text":"<p>The SARIF PHP SDK can be directly used from GitHub by cloning the repository into a directory of your choice.</p> <pre><code>git clone -b 1.3 https://github.com/llaville/sarif-php-sdk.git\n</code></pre>"},{"location":"builder/","title":"Index","text":""},{"location":"builder/#builders","title":"Builders","text":"<p>When SARIF PHP SDK is used to generate reports the standard API reclaims to declare each object and know how to link them. It can often be tedious to manually construct objects.</p> <p>Since release 1.5.0, the project provides a number of utilities to simplify the construction of sarif objects with their properties.</p> <p></p>"},{"location":"builder/#fluent-builders","title":"Fluent builders","text":"<p>The library comes with a number of builders, which allow creating sarif objects using a fluent interface. Builders are created using the <code>Bartlett\\Sarif\\Factory\\BuilderFactory</code> and the final constructed object is accessed through <code>build()</code>.</p> <p>Here is an example:</p> <pre><code>&lt;?php\nuse Bartlett\\Sarif\\Factory\\BuilderFactory;\n\n$factory = new BuilderFactory();\n\n$spec = $factory-&gt;specification('2.1.0')\n    -&gt;addRun(\n        $factory-&gt;run()\n            -&gt;tool(\n                $factory-&gt;tool()\n                    -&gt;driver(\n                        $factory-&gt;driver()\n                            -&gt;name('Psalm')\n                            -&gt;version('4.x-dev')\n                            -&gt;informationUri('https://psalm.de')\n                    )\n            )\n            -&gt;setProperties([\n                'stableId' =&gt; 'Nightly static analysis run',\n            ])\n    )\n;\n\n$sarifLogObject = $spec-&gt;build();\n</code></pre>"},{"location":"github-code-scanning/","title":"Index","text":""},{"location":"github-code-scanning/#github-code-scanning","title":"GitHub Code Scanning","text":"<p>You can use code scanning to find security vulnerabilities and errors in the code for your project on GitHub. Learn more on official GitHub documentation</p> <p>GitHub Code Scanning features are compatible with SARIF.</p> <p>[!NOTE] Since version 1.2.0</p> <ol> <li>The SARIF converter for PHP_CodeSniffer allows you to use PHP_CodeSniffer as GitHub Code Scanning tool.</li> <li>The SARIF converter for PHPLint allows you to use PHPLint as GitHub Code Scanning tool.</li> <li>The SARIF converter for PHPStan allows you to use PHPStan as GitHub Code Scanning tool.</li> </ol> <p>Don't forget to add enough permissions in your jobs :</p> <pre><code>    permissions:\n        # required for all workflows\n        security-events: write\n        # only required for workflows in private repositories\n        actions: read\n        contents: read\n</code></pre> <p>And enable CodeQL in your repository :</p> <ul> <li>Follows configuring default setup for code scanning steps.</li> </ul> <p>[!NOTE] Use codeql-action for running CodeQL analysis.</p> <p>You can upload SARIF files generated outside GitHub and see code scanning alerts from third-party tools in your repository.</p> <p>Learn more, and see how to Upload a SARIF file to GitHub.</p>"},{"location":"github-code-scanning/#php_codesniffer","title":"PHP_CodeSniffer","text":"<p>To use in one of your GitHub Actions workflows, add the following in your job:</p> <pre><code>jobs:\n    phpcs-analysis:\n        name: PHPCS analysis\n\n        steps:\n            -   # https://github.com/llaville/sarif-php-sdk/tree/master/examples/converters/phpcs\n                name: Install PHPCS SARIF Converter\n                run: composer require --dev --prefer-dist --no-progress squizlabs/php_codesniffer bartlett/sarif-php-sdk\n\n            -   # https://github.com/PHPCSStandards/PHP_CodeSniffer\n                name: Run PHPCS analysis\n                continue-on-error: true\n                run: vendor/bin/phpcs --report='\\Bartlett\\Sarif\\Converter\\PhpCsConverter' --report-file=phpcs.sarif.json\n\n            -   # https://github.com/github/codeql-action\n                name: Upload analysis results to GitHub\n                uses: github/codeql-action/upload-sarif@v3\n                with:\n                    sarif_file: phpcs.sarif.json\n                    wait-for-processing: true\n</code></pre> <p>[!WARNING] Be sure to have a PHPCS xml config file that declare a sufficient autoloader.</p> <p>See full CodeQL analysis job.</p>"},{"location":"github-code-scanning/#phplint","title":"PHPLint","text":"<p>To use in one of your GitHub Actions workflows, add the following in your job:</p> <pre><code>jobs:\n    phplint-analysis:\n        name: PHPLint analysis\n\n        steps:\n            -   # https://github.com/llaville/sarif-php-sdk/tree/master/examples/converters/phplint\n                name: Install PHPLint SARIF Converter\n                run: composer require --dev --prefer-dist --no-progress overtrue/phplint bartlett/sarif-php-sdk\n\n            -   # https://github.com/overtrue/phplint\n                name: Run PHPLint analysis\n                continue-on-error: true\n                run: vendor/bin/phplint --log-sarif=phplint.sarif.json --bootstrap autoload.php\n\n            -   # https://github.com/github/codeql-action\n                name: Upload analysis results to GitHub\n                uses: github/codeql-action/upload-sarif@v3\n                with:\n                    sarif_file: phplint.sarif.json\n                    wait-for-processing: true\n</code></pre> <p>[!WARNING] Be sure to have a sufficient autoloader (<code>bootstrap</code> option), especially if you customize your SARIF converter.</p> <p>See full CodeQL analysis job.</p>"},{"location":"github-code-scanning/#phpstan","title":"PHPStan","text":"<p>To use in one of your GitHub Actions workflows, add the following in your job:</p> <pre><code>jobs:\n    phpstan-analysis:\n        name: PHPStan analysis\n\n        steps:\n            -   # https://github.com/llaville/sarif-php-sdk/tree/master/examples/converters/phpstan\n              name: Install PHPStan SARIF Converter\n              run: composer require --dev --prefer-dist --no-progress phpstan/phpstan bartlett/sarif-php-sdk\n\n            -   # https://github.com/phpstan/phpstan\n              name: Run PHPStan analysis\n              continue-on-error: true\n              run: vendor/bin/phpstan analyze --configuration=phpstan.neon.dist --error-format=sarif --autoload-file vendor/autoload.php &gt; phpstan.sarif.json\n\n            -   # https://github.com/github/codeql-action\n              name: Upload analysis results to GitHub\n              uses: github/codeql-action/upload-sarif@v3\n              with:\n                  sarif_file: phpstan.sarif.json\n                  wait-for-processing: true\n</code></pre> <p>[!WARNING] Be sure to have a sufficient neon config file that defined the SARIF formatter to use.</p> <p>E.g with default converter :</p> <pre><code>services:\n    errorFormatter.sarif:\n        class: Bartlett\\Sarif\\Converter\\PhpStanConverter\n</code></pre> <p>See full CodeQL analysis job.</p>"},{"location":"reference/","title":"API Reference","text":""},{"location":"reference/#address-object","title":"address object","text":"<p>See official specification</p>"},{"location":"reference/#artifact-object","title":"artifact object","text":"<p>See official specification</p>"},{"location":"reference/#artifactchange-object","title":"artifactChange object","text":"<p>See official specification</p>"},{"location":"reference/#artifactcontent-object","title":"artifactContent object","text":"<p>See official specification</p>"},{"location":"reference/#attachment-object","title":"attachment object","text":"<p>See official specification</p>"},{"location":"reference/#codeflow-object","title":"codeFlow object","text":"<p>See official specification</p>"},{"location":"reference/#configurationoverride-object","title":"configurationOverride object","text":"<p>See official specification</p>"},{"location":"reference/#conversion-object","title":"conversion object","text":"<p>See official specification</p>"},{"location":"reference/#edge-object","title":"edge object","text":"<p>See official specification</p>"},{"location":"reference/#edgetraversal-object","title":"edgeTraversal object","text":"<p>See official specification</p>"},{"location":"reference/#exception-object","title":"exception object","text":"<p>See official specification</p>"},{"location":"reference/#externalproperties-object","title":"externalProperties object","text":"<p>See official specification</p>"},{"location":"reference/#externalpropertyfilereference-object","title":"externalPropertyFileReference object","text":"<p>See official specification</p>"},{"location":"reference/#externalpropertyfilereferences-object","title":"externalPropertyFileReferences object","text":"<p>See official specification</p>"},{"location":"reference/#fix-object","title":"fix object","text":"<p>See official specification</p>"},{"location":"reference/#graph-object","title":"graph object","text":"<p>See official specification</p>"},{"location":"reference/#graphtraversal-object","title":"graphTraversal object","text":"<p>See official specification</p>"},{"location":"reference/#invocation-object","title":"invocation object","text":"<p>See official specification</p>"},{"location":"reference/#locationrelationship-object","title":"locationRelationship object","text":"<p>See official specification</p>"},{"location":"reference/#logicallocation-object","title":"logicalLocation object","text":"<p>See official specification</p>"},{"location":"reference/#message-object","title":"message object","text":"<p>See official specification</p>"},{"location":"reference/#node-object","title":"node object","text":"<p>See official specification</p>"},{"location":"reference/#notification-object","title":"notification object","text":"<p>See official specification</p>"},{"location":"reference/#physicallocation-object","title":"physicalLocation object","text":"<p>See official specification</p>"},{"location":"reference/#rectangle-object","title":"rectangle object","text":"<p>See official specification</p>"},{"location":"reference/#replacement-object","title":"replacement object","text":"<p>See official specification</p>"},{"location":"reference/#reportingconfiguration-object","title":"reportingConfiguration object","text":"<p>See official specification</p>"},{"location":"reference/#reportingdescriptor-object","title":"reportingDescriptor object","text":"<p>See official specification</p>"},{"location":"reference/#reportingdescriptorreference-object","title":"reportingDescriptorReference object","text":"<p>See official specification</p>"},{"location":"reference/#reportingdescriptorrelationship-object","title":"reportingDescriptorRelationship object","text":"<p>See official specification</p>"},{"location":"reference/#result-object","title":"result object","text":"<p>See official specification</p>"},{"location":"reference/#resultprovenance-object","title":"resultProvenance object","text":"<p>See official specification</p>"},{"location":"reference/#run-object","title":"run object","text":"<p>See official specification</p>"},{"location":"reference/#runautomationdetails-object","title":"runAutomationDetails object","text":"<p>See official specification</p>"},{"location":"reference/#sariflog-object","title":"sarifLog object","text":"<p>See official specification</p>"},{"location":"reference/#speciallocations-object","title":"specialLocations object","text":"<p>See official specification</p>"},{"location":"reference/#stack-object","title":"stack object","text":"<p>See official specification</p>"},{"location":"reference/#stackframe-object","title":"stackFrame object","text":"<p>See official specification</p>"},{"location":"reference/#suppression-object","title":"suppression object","text":"<p>See official specification</p>"},{"location":"reference/#threadflow-object","title":"threadFlow object","text":"<p>See official specification</p>"},{"location":"reference/#threadflowlocation-object","title":"threadFlowLocation object","text":"<p>See official specification</p>"},{"location":"reference/#tool-object","title":"tool object","text":"<p>See official specification</p>"},{"location":"reference/#toolcomponentreference-object","title":"toolComponentReference object","text":"<p>See official specification</p>"},{"location":"reference/#translationmetadata-object","title":"translationMetadata object","text":"<p>See official specification</p>"},{"location":"reference/#versioncontroldetails-object","title":"versionControlDetails object","text":"<p>See official specification</p>"},{"location":"reference/#webrequest-object","title":"webRequest object","text":"<p>See official specification</p>"},{"location":"reference/#webresponse-object","title":"webResponse object","text":"<p>See official specification</p>"},{"location":"reference/address/","title":"Address","text":""},{"location":"reference/address/#address-object","title":"address object","text":"<p>An <code>address</code> object describes a physical or virtual address, or a range of addresses, in an \u201caddressable region\u201d (memory or a binary file).</p> <p></p>"},{"location":"reference/address/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"addresses\": [\n                {\n                    \"absoluteAddress\": 1024,\n                    \"kind\": \"module\",\n                    \"name\": \"Multitool.exe\"\n                },\n                {\n                    \"absoluteAddress\": 1400,\n                    \"relativeAddress\": 376,\n                    \"kind\": \"header\",\n                    \"name\": \"Sections\",\n                    \"offsetFromParent\": 376,\n                    \"parentIndex\": 0\n                },\n                {\n                    \"absoluteAddress\": 1536,\n                    \"relativeAddress\": 512,\n                    \"kind\": \"section\",\n                    \"name\": \".text\",\n                    \"offsetFromParent\": 136,\n                    \"parentIndex\": 1\n                }\n            ],\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/address/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/address.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/address.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Address;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$address1 = new Address();\n$address1-&gt;setName('Multitool.exe');\n$address1-&gt;setKind('module');\n$address1-&gt;setAbsoluteAddress(1024);\n\n$address2 = new Address();\n$address2-&gt;setName('Sections');\n$address2-&gt;setKind('header');\n$address2-&gt;setParentIndex(0);\n$address2-&gt;setOffsetFromParent(376);\n$address2-&gt;setAbsoluteAddress(1400);\n$address2-&gt;setRelativeAddress(376);\n\n$address3 = new Address();\n$address3-&gt;setName('.text');\n$address3-&gt;setKind('section');\n$address3-&gt;setParentIndex(1);\n$address3-&gt;setOffsetFromParent(136);\n$address3-&gt;setAbsoluteAddress(1536);\n$address3-&gt;setRelativeAddress(512);\n\n$run = new Run($tool);\n$run-&gt;addAddresses([$address1, $address2, $address3]);\n</code></pre>"},{"location":"reference/artifact/","title":"Artifact","text":""},{"location":"reference/artifact/#artifact-object","title":"artifact object","text":"<p>An <code>artifact</code> object represents a single artifact.</p> <p></p>"},{"location":"reference/artifact/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"artifacts\": [\n                {\n                    \"location\": {\n                        \"uri\": \"file:///C:/Code/app.zip\"\n                    },\n                    \"mimeType\": \"application/zip\"\n                },\n                {\n                    \"location\": {\n                        \"uri\": \"docs/intro.docx\"\n                    },\n                    \"mimeType\": \"application/vnd.openxmlformats-officedocument.wordprocessingml.document\"\n                },\n                {\n                    \"parentIndex\": 1,\n                    \"offset\": 17522,\n                    \"length\": 4050,\n                    \"mimeType\": \"application/x-contoso-animation\"\n                }\n            ],\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/artifact/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/artifact.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/artifact.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Artifact;\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$artifact1 = new Artifact();\n$artifactLocation1 = new ArtifactLocation();\n$artifactLocation1-&gt;setUri('file:///C:/Code/app.zip');\n$artifact1-&gt;setLocation($artifactLocation1);\n$artifact1-&gt;setMimeType('application/zip');\n\n$artifact2 = new Artifact();\n$artifactLocation2 = new ArtifactLocation();\n$artifactLocation2-&gt;setUri('docs/intro.docx');\n$artifact2-&gt;setLocation($artifactLocation2);\n$artifact2-&gt;setMimeType('application/vnd.openxmlformats-officedocument.wordprocessingml.document');\n$artifact2-&gt;setParentIndex(0);\n\n$artifact3 = new Artifact();\n$artifact3-&gt;setOffset(17522);\n$artifact3-&gt;setLength(4050);\n$artifact3-&gt;setMimeType('application/x-contoso-animation');\n$artifact3-&gt;setParentIndex(1);\n\n$run = new Run($tool);\n$run-&gt;addArtifacts([$artifact1, $artifact2, $artifact3]);\n</code></pre>"},{"location":"reference/artifactChange/","title":"artifactChange","text":""},{"location":"reference/artifactChange/#artifactchange-object","title":"artifactChange object","text":"<p>An <code>artifactChange</code> object represents a change to a single artifact.</p> <p></p>"},{"location":"reference/artifactChange/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CA1001\",\n                    \"fixes\": [\n                        {\n                            \"artifactChanges\": [\n                                {\n                                    \"artifactLocation\": {\n                                        \"uri\": \"src/a.c\"\n                                    },\n                                    \"replacements\": [\n                                        {\n                                            \"deletedRegion\": {\n                                                \"startLine\": 1,\n                                                \"startColumn\": 1,\n                                                \"endLine\": 1\n                                            },\n                                            \"insertedContent\": {\n                                                \"text\": \"// \"\n                                            }\n                                        }\n                                    ]\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/artifactChange/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/fix.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/fix.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactChange;\nuse Bartlett\\Sarif\\Definition\\ArtifactContent;\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Replacement;\n\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('src/a.c');\n$replacement = new Replacement(new Region(1, 1, 1));\n$insertedContent = new ArtifactContent();\n$insertedContent-&gt;setText('// ');\n$replacement-&gt;setInsertedContent($insertedContent);\n$artifactChange = new ArtifactChange($artifactLocation, [$replacement]);\n</code></pre>"},{"location":"reference/artifactContent/","title":"artifactContent","text":""},{"location":"reference/artifactContent/#artifactcontent-object","title":"artifactContent object","text":"<p>Certain properties in this document represent the contents of portions of artifacts external to the log file, for example, artifacts that were scanned by an analysis tool. SARIF represents such content with an <code>artifactContent</code> object. Depending on the circumstances, the SARIF log file might need to represent this content as readable text, raw bytes, or both.</p> <p></p>"},{"location":"reference/artifactContent/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CA1001\",\n                    \"fixes\": [\n                        {\n                            \"artifactChanges\": [\n                                {\n                                    \"artifactLocation\": {\n                                        \"uri\": \"src/a.c\"\n                                    },\n                                    \"replacements\": [\n                                        {\n                                            \"deletedRegion\": {\n                                                \"startLine\": 1,\n                                                \"startColumn\": 1,\n                                                \"endLine\": 1\n                                            },\n                                            \"insertedContent\": {\n                                                \"text\": \"// \"\n                                            }\n                                        }\n                                    ]\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/artifactContent/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/fix.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/fix.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactChange;\nuse Bartlett\\Sarif\\Definition\\ArtifactContent;\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Replacement;\n\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('src/a.c');\n$replacement = new Replacement(new Region(1, 1, 1));\n$insertedContent = new ArtifactContent();\n$insertedContent-&gt;setText('// ');\n$replacement-&gt;setInsertedContent($insertedContent);\n$artifactChange = new ArtifactChange($artifactLocation, [$replacement]);\n</code></pre>"},{"location":"reference/attachment/","title":"Attachment","text":""},{"location":"reference/attachment/#attachment-object","title":"attachment object","text":"<p>An <code>attachment</code> object describes an artifact relevant to the detection of a result.</p> <p></p>"},{"location":"reference/attachment/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"fullName\": \"CodeScanner 1.1, Developer Preview (en-US)\",\n                    \"version\": \"1.1.2b12\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Have a look on screen shot provided\"\n                    },\n                    \"attachments\": [\n                        {\n                            \"artifactLocation\": {\n                                \"uri\": \"file:///C:/ScanOutput/image001.png\"\n                            },\n                            \"description\": {\n                                \"text\": \"Screen shot\"\n                            }\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/attachment/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/attachment.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/attachment.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Attachment;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$attachment = new Attachment();\n$attachment-&gt;setDescription(new Message('Screen shot'));\n$attachment-&gt;setArtifactLocation(new ArtifactLocation('file:///C:/ScanOutput/image001.png'));\n\n$result = new Result(new Message('Have a look on screen shot provided'));\n$result-&gt;addAttachments([$attachment]);\n</code></pre>"},{"location":"reference/codeFlow/","title":"codeFlow","text":""},{"location":"reference/codeFlow/#codeflow-object","title":"codeFlow object","text":"<p>A <code>codeFlow</code> object describes the progress of one or more programs through one or more thread flows, which together lead to the detection of a problem in the system being analyzed.</p> <p></p>"},{"location":"reference/codeFlow/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"A result object\"\n                    },\n                    \"codeFlows\": [\n                        {\n                            \"threadFlows\": [\n                                {\n                                    \"locations\": [\n                                        {\n                                            \"location\": {\n                                                \"physicalLocation\": {\n                                                    \"artifactLocation\": {\n                                                        \"uri\": \"ui/window.c\",\n                                                        \"uriBaseId\": \"SRCROOT\"\n                                                    },\n                                                    \"region\": {\n                                                        \"startLine\": 42\n                                                    }\n                                                }\n                                            },\n                                            \"state\": {\n                                                \"x\": {\n                                                    \"text\": \"42\"\n                                                },\n                                                \"y\": {\n                                                    \"text\": \"54\"\n                                                },\n                                                \"x+y\": {\n                                                    \"text\": \"96\"\n                                                }\n                                            },\n                                            \"nestingLevel\": 0,\n                                            \"executionOrder\": 2\n                                        }\n                                    ],\n                                    \"id\": \"thread-123\",\n                                    \"message\": {\n                                        \"text\": \"A threadFlow object\"\n                                    }\n                                }\n                            ],\n                            \"message\": {\n                                \"text\": \"A codeFlow object\"\n                            }\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/codeFlow/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/codeFlow.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/codeFlow.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\CodeFlow;\nuse Bartlett\\Sarif\\Definition\\Location;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\PhysicalLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Result;\nuse Bartlett\\Sarif\\Definition\\ThreadFlow;\nuse Bartlett\\Sarif\\Definition\\ThreadFlowLocation;\n\n$threadFlowLocation = new ThreadFlowLocation();\n$location = new Location();\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('ui/window.c');\n$artifactLocation-&gt;setUriBaseId('SRCROOT');\n$physicalLocation = new PhysicalLocation($artifactLocation);\n$physicalLocation-&gt;setRegion(new Region(42));\n$location-&gt;setPhysicalLocation($physicalLocation);\n$threadFlowLocation-&gt;setLocation($location);\n$threadFlowLocation-&gt;addAdditionalProperties([\n    'x' =&gt; new MultiformatMessageString('42'),\n    'y' =&gt; new MultiformatMessageString('54'),\n    'x+y' =&gt; new MultiformatMessageString('96'),\n]);\n$threadFlowLocation-&gt;setNestingLevel(0);\n$threadFlowLocation-&gt;setExecutionOrder(2);\n\n$threadFlow = new ThreadFlow([$threadFlowLocation]);\n$threadFlow-&gt;setId('thread-123');\n$threadFlow-&gt;setMessage(new Message('A threadFlow object'));\n\n$codeFlow = new CodeFlow([$threadFlow]);\n$codeFlow-&gt;setMessage(new Message('A codeFlow object'));\n\n$result = new Result(new Message('A result object'));\n$result-&gt;addCodeFlows([$codeFlow]);\n</code></pre>"},{"location":"reference/configurationOverride/","title":"configurationOverride","text":""},{"location":"reference/configurationOverride/#configurationoverride-object","title":"configurationOverride object","text":"<p>A <code>configurationOverride</code> object modifies the effective runtime configuration of a specified <code>reportingDescriptor</code> object, which we refer to as theDescriptor.</p> <p></p>"},{"location":"reference/configurationOverride/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CA2101\",\n                            \"defaultConfiguration\": {\n                                \"enabled\": true,\n                                \"level\": \"error\",\n                                \"rank\": -1\n                            }\n                        }\n                    ]\n                }\n            },\n            \"invocations\": [\n                {\n                    \"executionSuccessful\": true,\n                    \"ruleConfigurationOverrides\": [\n                        {\n                            \"configuration\": {\n                                \"enabled\": true,\n                                \"level\": \"warning\",\n                                \"rank\": -1\n                            },\n                            \"descriptor\": {\n                                \"index\": 0\n                            }\n                        }\n                    ]\n                }\n            ],\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/configurationOverride/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/configurationOverride.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/configurationOverride.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ConfigurationOverride;\nuse Bartlett\\Sarif\\Definition\\Invocation;\nuse Bartlett\\Sarif\\Definition\\ReportingConfiguration;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptor;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptorReference;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$rule = new ReportingDescriptor('CA2101');\n$reportingConf = new ReportingConfiguration();\n$reportingConf-&gt;setLevel('error');\n$rule-&gt;setDefaultConfiguration($reportingConf);\n$driver-&gt;addRules([$rule]);\n\n$ruleConf = new ReportingConfiguration();\n$ruleConf-&gt;setLevel('warning');\n\n$confOverrides = new ConfigurationOverride();\n$descriptor = new ReportingDescriptorReference(0);\n$confOverrides-&gt;setDescriptor($descriptor);\n$confOverrides-&gt;setConfiguration($ruleConf);\n\n$invocation = new Invocation(true);\n$invocation-&gt;addRuleConfigurationOverrides([$confOverrides]);\n\n$run = new Run($tool);\n$run-&gt;addInvocations([$invocation]);\n</code></pre>"},{"location":"reference/conversion/","title":"Conversion","text":""},{"location":"reference/conversion/#conversion-object","title":"conversion object","text":"<p>A <code>conversion</code> object describes how a converter transformed the output of an analysis tool from the analysis tool\u2019s native output format into the SARIF format.</p> <p></p>"},{"location":"reference/conversion/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"AndroidStudio\",\n                    \"semanticVersion\": \"1.0.0-beta.1\",\n                    \"informationUri\": \"https://android-studion.dev\"\n                }\n            },\n            \"conversion\": {\n                \"tool\": {\n                    \"driver\": {\n                        \"name\": \"SARIF SDK Multitool\"\n                    }\n                },\n                \"invocation\": {\n                    \"executionSuccessful\": true,\n                    \"commandLine\": \"Sarif.Multitool.exe convert -t AndroidStudio northwind.log\"\n                },\n                \"analysisToolLogFiles\": [\n                    {\n                        \"uri\": \"northwind.log\",\n                        \"uriBaseId\": \"$LOG_DIR$\"\n                    }\n                ]\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/conversion/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/conversion.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/conversion.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Conversion;\nuse Bartlett\\Sarif\\Definition\\Invocation;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('northwind.log');\n$artifactLocation-&gt;setUriBaseId('$LOG_DIR$');\n\n$invocation = new Invocation(true);\n$invocation-&gt;setCommandLine('Sarif.Multitool.exe convert -t AndroidStudio northwind.log');\n\n$conversion = new Conversion($converter);\n$conversion-&gt;addAnalysisToolLogFiles([$artifactLocation]);\n$conversion-&gt;setInvocation($invocation);\n\n$run = new Run($tool);\n$run-&gt;setConversion($conversion);\n</code></pre>"},{"location":"reference/edge/","title":"Edge","text":""},{"location":"reference/edge/#edge-object","title":"edge object","text":"<p>A <code>edge</code> object represents a directed edge in the graph represented by theGraph.</p> <p></p>"},{"location":"reference/edge/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"fullName\": \"CodeScanner 1.1, Developer Preview (en-US)\",\n                    \"version\": \"1.1.2b12\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Have a look on this graph\"\n                    },\n                    \"graphs\": [\n                        {\n                            \"nodes\": [\n                                {\n                                    \"id\": \"n2\"\n                                },\n                                {\n                                    \"id\": \"n3\"\n                                },\n                                {\n                                    \"id\": \"n4\"\n                                },\n                                {\n                                    \"id\": \"n1\",\n                                    \"children\": [\n                                        {\n                                            \"id\": \"n3\"\n                                        }\n                                    ]\n                                }\n                            ],\n                            \"edges\": [\n                                {\n                                    \"id\": \"e1\",\n                                    \"sourceNodeId\": \"n3\",\n                                    \"targetNodeId\": \"n4\"\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/edge/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/graph.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/graph.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Attachment;\nuse Bartlett\\Sarif\\Definition\\Edge;\nuse Bartlett\\Sarif\\Definition\\Graph;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Node;\nuse Bartlett\\Sarif\\Definition\\Rectangle;\nuse Bartlett\\Sarif\\Definition\\Result;\nuse Bartlett\\Sarif\\Definition\\Run;\nuse Bartlett\\Sarif\\Definition\\Tool;\nuse Bartlett\\Sarif\\Definition\\ToolComponent;\nuse Bartlett\\Sarif\\SarifLog;\n\n$nodes = [];\n$nodes[2] = new Node('n2');\n$nodes[3] = new Node('n3');\n$nodes[4] = new Node('n4');\n$nodes[1] = new Node('n1');\n$nodes[1]-&gt;addChildren([$nodes[3]]);\n\n$edges = [];\n$edges[1] = new Edge('e1', 'n3', 'n4');\n\n$graph = new Graph();\n$graph-&gt;addNodes($nodes);\n$graph-&gt;addEdges($edges);\n\n$result = new Result(new Message('Have a look on this graph'));\n$result-&gt;addGraphs([$graph]);\n</code></pre>"},{"location":"reference/edgeTraversal/","title":"edgeTraversal","text":""},{"location":"reference/edgeTraversal/#edgetraversal-object","title":"edgeTraversal object","text":"<p>An <code>edgeTraversal</code> object represents the traversal of a single edge during a graph traversal.</p> <p></p>"},{"location":"reference/edgeTraversal/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"A graph and edge traversal objects\"\n                    },\n                    \"graphs\": [\n                        {\n                            \"nodes\": [\n                                {\n                                    \"id\": \"n1\"\n                                },\n                                {\n                                    \"id\": \"n2\"\n                                },\n                                {\n                                    \"id\": \"n3\"\n                                },\n                                {\n                                    \"id\": \"n4\"\n                                }\n                            ],\n                            \"edges\": [\n                                {\n                                    \"id\": \"e1\",\n                                    \"sourceNodeId\": \"n1\",\n                                    \"targetNodeId\": \"n2\"\n                                },\n                                {\n                                    \"id\": \"e2\",\n                                    \"sourceNodeId\": \"n2\",\n                                    \"targetNodeId\": \"n3\"\n                                },\n                                {\n                                    \"id\": \"e3\",\n                                    \"sourceNodeId\": \"n2\",\n                                    \"targetNodeId\": \"n4\"\n                                }\n                            ]\n                        }\n                    ],\n                    \"graphTraversals\": [\n                        {\n                            \"resultGraphIndex\": 0,\n                            \"initialState\": {\n                                \"x\": {\n                                    \"text\": \"1\"\n                                },\n                                \"y\": {\n                                    \"text\": \"2\"\n                                },\n                                \"x+y\": {\n                                    \"text\": \"3\"\n                                }\n                            },\n                            \"edgeTraversals\": [\n                                {\n                                    \"edgeId\": \"e1\",\n                                    \"finalState\": {\n                                        \"x\": {\n                                            \"text\": \"4\"\n                                        },\n                                        \"y\": {\n                                            \"text\": \"2\"\n                                        },\n                                        \"x+y\": {\n                                            \"text\": \"6\"\n                                        }\n                                    }\n                                },\n                                {\n                                    \"edgeId\": \"e3\",\n                                    \"finalState\": {\n                                        \"x\": {\n                                            \"text\": \"4\"\n                                        },\n                                        \"y\": {\n                                            \"text\": \"7\"\n                                        },\n                                        \"x+y\": {\n                                            \"text\": \"11\"\n                                        }\n                                    }\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/edgeTraversal/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/graphTraversal.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/graphTraversal.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Edge;\nuse Bartlett\\Sarif\\Definition\\EdgeTraversal;\nuse Bartlett\\Sarif\\Definition\\Graph;\nuse Bartlett\\Sarif\\Definition\\GraphTraversal;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\Node;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$nodes = [];\n$nodes[1] = new Node('n1');\n$nodes[2] = new Node('n2');\n$nodes[3] = new Node('n3');\n$nodes[4] = new Node('n4');\n\n$edges = [];\n$edges[1] = new Edge('e1', 'n1', 'n2');\n$edges[2] = new Edge('e2', 'n2', 'n3');\n$edges[3] = new Edge('e3', 'n2', 'n4');\n\n$graph = new Graph();\n$graph-&gt;addNodes($nodes);\n$graph-&gt;addEdges($edges);\n\n$graphTraversal = new GraphTraversal(null, 0);\n$graphTraversal-&gt;addAdditionalPropertiesInitialState([\n    'x' =&gt; new MultiformatMessageString('1'),\n    'y' =&gt; new MultiformatMessageString('2'),\n    'x+y' =&gt; new MultiformatMessageString('3'),\n]);\n\n$edgeTraversal1 = new EdgeTraversal('e1');\n$edgeTraversal1-&gt;addAdditionalProperties([\n    'x' =&gt; new MultiformatMessageString('4'),\n    'y' =&gt; new MultiformatMessageString('2'),\n    'x+y' =&gt; new MultiformatMessageString('6'),\n]);\n$edgeTraversal3 = new EdgeTraversal('e3');\n$edgeTraversal3-&gt;addAdditionalProperties([\n    'x' =&gt; new MultiformatMessageString('4'),\n    'y' =&gt; new MultiformatMessageString('7'),\n    'x+y' =&gt; new MultiformatMessageString('11'),\n]);\n$graphTraversal-&gt;addEdgeTraversals([$edgeTraversal1, $edgeTraversal3]);\n\n$result = new Result(new Message('A graph and edge traversal objects'));\n$result-&gt;addGraphs([$graph]);\n$result-&gt;addGraphTraversals([$graphTraversal]);\n</code></pre>"},{"location":"reference/exception/","title":"Exception","text":""},{"location":"reference/exception/#exception-object","title":"exception object","text":"<p>An <code>exception</code> object describes a runtime exception encountered during the execution of an analysis tool. This includes signals in POSIX-conforming operating systems.</p> <p></p>"},{"location":"reference/exception/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CTN9999\",\n                            \"shortDescription\": {\n                                \"text\": \"First version of rule.\"\n                            }\n                        },\n                        {\n                            \"id\": \"CTN9999\",\n                            \"shortDescription\": {\n                                \"text\": \"Second version of rule.\"\n                            }\n                        }\n                    ]\n                }\n            },\n            \"invocations\": [\n                {\n                    \"executionSuccessful\": true,\n                    \"toolExecutionNotifications\": [\n                        {\n                            \"message\": {\n                                \"text\": \"Exception evaluating rule 'C2001'. Rule configuration is missing.\"\n                            },\n                            \"level\": \"error\",\n                            \"exception\": {\n                                \"message\": \"Exception evaluating rule 'C2001'\"\n                            },\n                            \"descriptor\": {\n                                \"index\": 1,\n                                \"id\": \"CTN9999\"\n                            }\n                        }\n                    ]\n                }\n            ],\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CTN9999\"\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/exception/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/exception.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/exception.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Exception;\nuse Bartlett\\Sarif\\Definition\\Invocation;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\Notification;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptor;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptorReference;\nuse Bartlett\\Sarif\\Definition\\Result;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$notification = new Notification(new Message(\"Exception evaluating rule 'C2001'. Rule configuration is missing.\"));\n$notification-&gt;setAssociatedRule(new ReportingDescriptorReference(0, 'C2001'));\n$notification-&gt;setDescriptor(new ReportingDescriptorReference(1, 'CTN9999'));\n$notification-&gt;setLevel('error');\n$exception = new Exception();\n$exception-&gt;setMessage(\"Exception evaluating rule 'C2001'\");\n$notification-&gt;setRuntimeException($exception);\n$invocation = new Invocation(true);\n$invocation-&gt;addToolExecutionNotifications([$notification]);\n\n$result = new Result(new Message('...'));\n$result-&gt;setRuleId('CTN9999');\n\n$run = new Run($tool);\n$run-&gt;addResults([$result]);\n$run-&gt;addInvocations([$invocation]);\n</code></pre>"},{"location":"reference/externalProperties/","title":"externalProperties","text":""},{"location":"reference/externalProperties/#externalproperties-object","title":"externalProperties object","text":"<p>The top-level element of an external property file SHALL be an object which we refer to as an <code>externalProperties</code> object.</p> <p></p>"},{"location":"reference/externalProperties/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": []\n        }\n    ],\n    \"inlineExternalProperties\": [\n        {\n            \"schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n            \"version\": \"2.1.0\",\n            \"guid\": \"00001111-2222-1111-8888-555566667777\",\n            \"runGuid\": \"88889999-AAAA-1111-8888-DDDDEEEEFFFF\",\n            \"externalizedProperties\": {\n                \"team\": \"Security Assurance Team\"\n            },\n            \"artifacts\": [\n                {\n                    \"location\": {\n                        \"uri\": \"apple.png\"\n                    },\n                    \"mimeType\": \"image/png\"\n                },\n                {\n                    \"location\": {\n                        \"uri\": \"banana.png\"\n                    },\n                    \"mimeType\": \"image/png\"\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/externalProperties/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/externalProperties.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/externalProperties.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Artifact;\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\ExternalProperties;\nuse Bartlett\\Sarif\\Definition\\PropertyBag;\nuse Bartlett\\Sarif\\Definition\\Run;\nuse Bartlett\\Sarif\\SarifLog;\n\n$apple = new Artifact();\n$location = new ArtifactLocation();\n$location-&gt;setUri('apple.png');\n$apple-&gt;setLocation($location);\n$apple-&gt;setMimeType('image/png');\n\n$banana = new Artifact();\n$location = new ArtifactLocation();\n$location-&gt;setUri('banana.png');\n$banana-&gt;setLocation($location);\n$banana-&gt;setMimeType('image/png');\n\n$propertyBag = new PropertyBag();\n$propertyBag-&gt;addProperty('team', 'Security Assurance Team');\n\n$run = new Run($tool);\n\n$log = new SarifLog([$run]);\n$externalProperties = new ExternalProperties();\n$externalProperties-&gt;setGuid('00001111-2222-1111-8888-555566667777');\n$externalProperties-&gt;setRunGuid('88889999-AAAA-1111-8888-DDDDEEEEFFFF');\n$externalProperties-&gt;addArtifacts([$apple, $banana]);\n$externalProperties-&gt;setExternalizedProperties($propertyBag);\n$log-&gt;addInlineExternalProperties([$externalProperties]);\n</code></pre>"},{"location":"reference/externalPropertyFileReference/","title":"externalPropertyFileReference","text":""},{"location":"reference/externalPropertyFileReference/#externalpropertyfilereference-object","title":"externalPropertyFileReference object","text":"<p>An <code>externalPropertyFileReference</code> object contains information that enables a SARIF consumer to locate the external property files that contain the values of all externalized properties associated with theRun.</p> <p></p>"},{"location":"reference/externalPropertyFileReference/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"originalUriBaseIds\": {\n                \"LOGSDIR\": {\n                    \"uri\": \"file:///C:/logs/\"\n                }\n            },\n            \"externalPropertyFileReferences\": {\n                \"conversion\": {\n                    \"location\": {\n                        \"uri\": \"scantool.conversion.sarif-external-properties\",\n                        \"uriBaseId\": \"LOGSDIR\"\n                    },\n                    \"guid\": \"11111111-1111-1111-8888-111111111111\"\n                },\n                \"results\": [\n                    {\n                        \"location\": {\n                            \"uri\": \"scantool.results-1.sarif-external-properties\",\n                            \"uriBaseId\": \"LOGSDIR\"\n                        },\n                        \"guid\": \"22222222-2222-1111-8888-222222222222\",\n                        \"itemCount\": 1000\n                    },\n                    {\n                        \"location\": {\n                            \"uri\": \"scantool.results-2.sarif-external-properties\",\n                            \"uriBaseId\": \"LOGSDIR\"\n                        },\n                        \"guid\": \"33333333-3333-1111-8888-333333333333\",\n                        \"itemCount\": 4277\n                    }\n                ]\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/externalPropertyFileReference/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/externalPropertyFileReferences.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/externalPropertyFileReferences.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\ExternalPropertyFileReference;\nuse Bartlett\\Sarif\\Definition\\ExternalPropertyFileReferences;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$run = new Run($tool);\n$logsDir = new ArtifactLocation();\n$logsDir-&gt;setUri('file:///C:/logs/');\n$run-&gt;addAdditionalProperties([\n    'LOGSDIR' =&gt; $logsDir,\n]);\n\n$location = new ArtifactLocation();\n$location-&gt;setUri('scantool.conversion.sarif-external-properties');\n$location-&gt;setUriBaseId('LOGSDIR');\n$conversion = new ExternalPropertyFileReference($location, '11111111-1111-1111-8888-111111111111');\n\n$location = new ArtifactLocation();\n$location-&gt;setUri('scantool.results-1.sarif-external-properties');\n$location-&gt;setUriBaseId('LOGSDIR');\n$resultRef1 = new ExternalPropertyFileReference($location, '22222222-2222-1111-8888-222222222222');\n$resultRef1-&gt;setItemCount(1000);\n\n$location = new ArtifactLocation();\n$location-&gt;setUri('scantool.results-2.sarif-external-properties');\n$location-&gt;setUriBaseId('LOGSDIR');\n$resultRef2 = new ExternalPropertyFileReference($location, '33333333-3333-1111-8888-333333333333');\n$resultRef2-&gt;setItemCount(4277);\n\n$externalPropertyFileReferences = new ExternalPropertyFileReferences();\n$externalPropertyFileReferences-&gt;setConversion($conversion);\n$externalPropertyFileReferences-&gt;addResults([$resultRef1, $resultRef2]);\n$run-&gt;setExternalPropertyFileReferences($externalPropertyFileReferences);\n</code></pre>"},{"location":"reference/externalPropertyFileReferences/","title":"externalPropertyFileReferences","text":""},{"location":"reference/externalPropertyFileReferences/#externalpropertyfilereferences-object","title":"externalPropertyFileReferences object","text":"<p>An <code>externalPropertyFileReferences</code> object contains information that enables a SARIF consumer to locate the external property files that contain the values of all externalized properties associated with theRun.</p> <p></p>"},{"location":"reference/externalPropertyFileReferences/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"originalUriBaseIds\": {\n                \"LOGSDIR\": {\n                    \"uri\": \"file:///C:/logs/\"\n                }\n            },\n            \"externalPropertyFileReferences\": {\n                \"conversion\": {\n                    \"location\": {\n                        \"uri\": \"scantool.conversion.sarif-external-properties\",\n                        \"uriBaseId\": \"LOGSDIR\"\n                    },\n                    \"guid\": \"11111111-1111-1111-8888-111111111111\"\n                },\n                \"results\": [\n                    {\n                        \"location\": {\n                            \"uri\": \"scantool.results-1.sarif-external-properties\",\n                            \"uriBaseId\": \"LOGSDIR\"\n                        },\n                        \"guid\": \"22222222-2222-1111-8888-222222222222\",\n                        \"itemCount\": 1000\n                    },\n                    {\n                        \"location\": {\n                            \"uri\": \"scantool.results-2.sarif-external-properties\",\n                            \"uriBaseId\": \"LOGSDIR\"\n                        },\n                        \"guid\": \"33333333-3333-1111-8888-333333333333\",\n                        \"itemCount\": 4277\n                    }\n                ]\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/externalPropertyFileReferences/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/externalPropertyFileReferences.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/externalPropertyFileReferences.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\ExternalPropertyFileReference;\nuse Bartlett\\Sarif\\Definition\\ExternalPropertyFileReferences;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$run = new Run($tool);\n$logsDir = new ArtifactLocation();\n$logsDir-&gt;setUri('file:///C:/logs/');\n$run-&gt;addAdditionalProperties([\n    'LOGSDIR' =&gt; $logsDir,\n]);\n\n$location = new ArtifactLocation();\n$location-&gt;setUri('scantool.conversion.sarif-external-properties');\n$location-&gt;setUriBaseId('LOGSDIR');\n$conversion = new ExternalPropertyFileReference($location, '11111111-1111-1111-8888-111111111111');\n\n$location = new ArtifactLocation();\n$location-&gt;setUri('scantool.results-1.sarif-external-properties');\n$location-&gt;setUriBaseId('LOGSDIR');\n$resultRef1 = new ExternalPropertyFileReference($location, '22222222-2222-1111-8888-222222222222');\n$resultRef1-&gt;setItemCount(1000);\n\n$location = new ArtifactLocation();\n$location-&gt;setUri('scantool.results-2.sarif-external-properties');\n$location-&gt;setUriBaseId('LOGSDIR');\n$resultRef2 = new ExternalPropertyFileReference($location, '33333333-3333-1111-8888-333333333333');\n$resultRef2-&gt;setItemCount(4277);\n\n$externalPropertyFileReferences = new ExternalPropertyFileReferences();\n$externalPropertyFileReferences-&gt;setConversion($conversion);\n$externalPropertyFileReferences-&gt;addResults([$resultRef1, $resultRef2]);\n$run-&gt;setExternalPropertyFileReferences($externalPropertyFileReferences);\n</code></pre>"},{"location":"reference/fix/","title":"Fix","text":""},{"location":"reference/fix/#fix-object","title":"fix object","text":"<p>A <code>fix</code> object represents a proposed fix for the problem indicated by theResult. It specifies a set of artifacts to modify. For each artifact, it specifies regions to remove, and provides new content to insert.</p> <p></p>"},{"location":"reference/fix/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CA1001\",\n                    \"fixes\": [\n                        {\n                            \"artifactChanges\": [\n                                {\n                                    \"artifactLocation\": {\n                                        \"uri\": \"src/a.c\"\n                                    },\n                                    \"replacements\": [\n                                        {\n                                            \"deletedRegion\": {\n                                                \"startLine\": 1,\n                                                \"startColumn\": 1,\n                                                \"endLine\": 1\n                                            },\n                                            \"insertedContent\": {\n                                                \"text\": \"// \"\n                                            }\n                                        }\n                                    ]\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/fix/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/fix.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/fix.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactChange;\nuse Bartlett\\Sarif\\Definition\\ArtifactContent;\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Fix;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Replacement;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('src/a.c');\n$replacement = new Replacement(new Region(1, 1, 1));\n$insertedContent = new ArtifactContent();\n$insertedContent-&gt;setText('// ');\n$replacement-&gt;setInsertedContent($insertedContent);\n$artifactChange = new ArtifactChange($artifactLocation, [$replacement]);\n\n$fix = new Fix([$artifactChange]);\n\n$result = new Result(new Message('...'));\n$result-&gt;setRuleId('CA1001');\n$result-&gt;addFixes([$fix]);\n</code></pre>"},{"location":"reference/graph/","title":"Graph","text":""},{"location":"reference/graph/#graph-object","title":"graph object","text":"<p>A <code>graph</code> object represents a directed graph, a network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).</p> <p></p>"},{"location":"reference/graph/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"fullName\": \"CodeScanner 1.1, Developer Preview (en-US)\",\n                    \"version\": \"1.1.2b12\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Have a look on this graph\"\n                    },\n                    \"graphs\": [\n                        {\n                            \"nodes\": [\n                                {\n                                    \"id\": \"n2\"\n                                },\n                                {\n                                    \"id\": \"n3\"\n                                },\n                                {\n                                    \"id\": \"n4\"\n                                },\n                                {\n                                    \"id\": \"n1\",\n                                    \"children\": [\n                                        {\n                                            \"id\": \"n3\"\n                                        }\n                                    ]\n                                }\n                            ],\n                            \"edges\": [\n                                {\n                                    \"id\": \"e1\",\n                                    \"sourceNodeId\": \"n3\",\n                                    \"targetNodeId\": \"n4\"\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/graph/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/graph.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/graph.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Edge;\nuse Bartlett\\Sarif\\Definition\\Graph;\nuse Bartlett\\Sarif\\Definition\\Node;\n\n$nodes = [];\n$nodes[2] = new Node('n2');\n$nodes[3] = new Node('n3');\n$nodes[4] = new Node('n4');\n$nodes[1] = new Node('n1');\n$nodes[1]-&gt;addChildren([$nodes[3]]);\n\n$edges = [];\n$edges[1] = new Edge('e1', 'n3', 'n4');\n\n$graph = new Graph();\n$graph-&gt;addNodes($nodes);\n$graph-&gt;addEdges($edges);\n</code></pre>"},{"location":"reference/graphTraversal/","title":"graphTraversal","text":""},{"location":"reference/graphTraversal/#graphtraversal-object","title":"graphTraversal object","text":"<p>A <code>graphTraversal</code> object represents a \"graph traversal\", that is, a path through a graph specified by a sequence of connected \"edge traversals\", each of which is represented by an <code>edgeTraversal</code> object.</p> <p></p>"},{"location":"reference/graphTraversal/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"A graph and edge traversal objects\"\n                    },\n                    \"graphs\": [\n                        {\n                            \"nodes\": [\n                                {\n                                    \"id\": \"n1\"\n                                },\n                                {\n                                    \"id\": \"n2\"\n                                },\n                                {\n                                    \"id\": \"n3\"\n                                },\n                                {\n                                    \"id\": \"n4\"\n                                }\n                            ],\n                            \"edges\": [\n                                {\n                                    \"id\": \"e1\",\n                                    \"sourceNodeId\": \"n1\",\n                                    \"targetNodeId\": \"n2\"\n                                },\n                                {\n                                    \"id\": \"e2\",\n                                    \"sourceNodeId\": \"n2\",\n                                    \"targetNodeId\": \"n3\"\n                                },\n                                {\n                                    \"id\": \"e3\",\n                                    \"sourceNodeId\": \"n2\",\n                                    \"targetNodeId\": \"n4\"\n                                }\n                            ]\n                        }\n                    ],\n                    \"graphTraversals\": [\n                        {\n                            \"resultGraphIndex\": 0,\n                            \"initialState\": {\n                                \"x\": {\n                                    \"text\": \"1\"\n                                },\n                                \"y\": {\n                                    \"text\": \"2\"\n                                },\n                                \"x+y\": {\n                                    \"text\": \"3\"\n                                }\n                            },\n                            \"edgeTraversals\": [\n                                {\n                                    \"edgeId\": \"e1\",\n                                    \"finalState\": {\n                                        \"x\": {\n                                            \"text\": \"4\"\n                                        },\n                                        \"y\": {\n                                            \"text\": \"2\"\n                                        },\n                                        \"x+y\": {\n                                            \"text\": \"6\"\n                                        }\n                                    }\n                                },\n                                {\n                                    \"edgeId\": \"e3\",\n                                    \"finalState\": {\n                                        \"x\": {\n                                            \"text\": \"4\"\n                                        },\n                                        \"y\": {\n                                            \"text\": \"7\"\n                                        },\n                                        \"x+y\": {\n                                            \"text\": \"11\"\n                                        }\n                                    }\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/graphTraversal/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/graphTraversal.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/graphTraversal.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Edge;\nuse Bartlett\\Sarif\\Definition\\EdgeTraversal;\nuse Bartlett\\Sarif\\Definition\\Graph;\nuse Bartlett\\Sarif\\Definition\\GraphTraversal;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\Node;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$nodes = [];\n$nodes[1] = new Node('n1');\n$nodes[2] = new Node('n2');\n$nodes[3] = new Node('n3');\n$nodes[4] = new Node('n4');\n\n$edges = [];\n$edges[1] = new Edge('e1', 'n1', 'n2');\n$edges[2] = new Edge('e2', 'n2', 'n3');\n$edges[3] = new Edge('e3', 'n2', 'n4');\n\n$graph = new Graph();\n$graph-&gt;addNodes($nodes);\n$graph-&gt;addEdges($edges);\n\n$graphTraversal = new GraphTraversal(null, 0);\n$graphTraversal-&gt;addAdditionalPropertiesInitialState([\n    'x' =&gt; new MultiformatMessageString('1'),\n    'y' =&gt; new MultiformatMessageString('2'),\n    'x+y' =&gt; new MultiformatMessageString('3'),\n]);\n\n$edgeTraversal1 = new EdgeTraversal('e1');\n$edgeTraversal1-&gt;addAdditionalProperties([\n    'x' =&gt; new MultiformatMessageString('4'),\n    'y' =&gt; new MultiformatMessageString('2'),\n    'x+y' =&gt; new MultiformatMessageString('6'),\n]);\n$edgeTraversal3 = new EdgeTraversal('e3');\n$edgeTraversal3-&gt;addAdditionalProperties([\n    'x' =&gt; new MultiformatMessageString('4'),\n    'y' =&gt; new MultiformatMessageString('7'),\n    'x+y' =&gt; new MultiformatMessageString('11'),\n]);\n$graphTraversal-&gt;addEdgeTraversals([$edgeTraversal1, $edgeTraversal3]);\n\n$result = new Result(new Message('A graph and edge traversal objects'));\n$result-&gt;addGraphs([$graph]);\n$result-&gt;addGraphTraversals([$graphTraversal]);\n</code></pre>"},{"location":"reference/invocation/","title":"Invocation","text":""},{"location":"reference/invocation/#invocation-object","title":"invocation object","text":"<p>An <code>invocation</code> object describes the invocation of the analysis tool that was run.</p> <p></p>"},{"location":"reference/invocation/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CTN9999\",\n                            \"shortDescription\": {\n                                \"text\": \"First version of rule.\"\n                            }\n                        },\n                        {\n                            \"id\": \"CTN9999\",\n                            \"shortDescription\": {\n                                \"text\": \"Second version of rule.\"\n                            }\n                        }\n                    ]\n                }\n            },\n            \"invocations\": [\n                {\n                    \"executionSuccessful\": true,\n                    \"toolExecutionNotifications\": [\n                        {\n                            \"message\": {\n                                \"text\": \"Exception evaluating rule 'C2001'. Rule configuration is missing.\"\n                            },\n                            \"level\": \"error\",\n                            \"descriptor\": {\n                                \"index\": 1,\n                                \"id\": \"CTN9999\"\n                            }\n                        }\n                    ]\n                }\n            ],\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CTN9999\"\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/invocation/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/reportingDescriptorReference.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/reportingDescriptorReference.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Invocation;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\Notification;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptor;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptorReference;\nuse Bartlett\\Sarif\\Definition\\Result;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$notification = new Notification(new Message(\"Exception evaluating rule 'C2001'. Rule configuration is missing.\"));\n$notification-&gt;setAssociatedRule(new ReportingDescriptorReference(0, 'C2001'));\n$notification-&gt;setDescriptor(new ReportingDescriptorReference(1, 'CTN9999'));\n$notification-&gt;setLevel('error');\n$invocation = new Invocation(true);\n$invocation-&gt;addToolExecutionNotifications([$notification]);\n\n$result = new Result(new Message('...'));\n$result-&gt;setRuleId('CTN9999');\n\n$run = new Run($tool);\n$run-&gt;addResults([$result]);\n$run-&gt;addInvocations([$invocation]);\n</code></pre>"},{"location":"reference/locationRelationship/","title":"locationRelationship","text":""},{"location":"reference/locationRelationship/#locationrelationship-object","title":"locationRelationship object","text":"<p>A <code>locationRelationship</code> object specifies one or more directed relationships from one location object, which we refer to as theSource, to another one, which we refer to as theTarget.</p> <p></p>"},{"location":"reference/locationRelationship/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"A result object with locationRelationship object\"\n                    },\n                    \"locations\": [\n                        {\n                            \"id\": 0,\n                            \"physicalLocation\": {\n                                \"artifactLocation\": {\n                                    \"uri\": \"f.h\"\n                                },\n                                \"region\": {\n                                    \"startLine\": 42\n                                }\n                            },\n                            \"relationships\": [\n                                {\n                                    \"target\": 1,\n                                    \"kinds\": [\n                                        \"isIncludedBy\"\n                                    ]\n                                }\n                            ]\n                        }\n                    ],\n                    \"relatedLocations\": [\n                        {\n                            \"id\": 1,\n                            \"physicalLocation\": {\n                                \"artifactLocation\": {\n                                    \"uri\": \"g.h\"\n                                },\n                                \"region\": {\n                                    \"startLine\": 17\n                                }\n                            },\n                            \"relationships\": [\n                                {\n                                    \"target\": 0,\n                                    \"kinds\": [\n                                        \"includes\"\n                                    ]\n                                },\n                                {\n                                    \"target\": 2,\n                                    \"kinds\": [\n                                        \"isIncludedBy\"\n                                    ]\n                                }\n                            ]\n                        },\n                        {\n                            \"id\": 2,\n                            \"physicalLocation\": {\n                                \"artifactLocation\": {\n                                    \"uri\": \"g.c\"\n                                },\n                                \"region\": {\n                                    \"startLine\": 8\n                                }\n                            },\n                            \"relationships\": [\n                                {\n                                    \"target\": 1,\n                                    \"kinds\": [\n                                        \"includes\"\n                                    ]\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/locationRelationship/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/locationRelationship.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/locationRelationship.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Location;\nuse Bartlett\\Sarif\\Definition\\LocationRelationship;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\PhysicalLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$location = [];\n$physicalLocation = [];\n$artifactLocation = [];\n$region = [];\n$relationships = [];\n\n$location[0] = new Location();\n$location[0]-&gt;setId(0);\n$artifactLocation[0] = new ArtifactLocation();\n$artifactLocation[0]-&gt;setUri('f.h');\n$physicalLocation[0] = new PhysicalLocation($artifactLocation[0]);\n$region[0] = new Region(42);\n$physicalLocation[0]-&gt;setRegion($region[0]);\n$location[0]-&gt;setPhysicalLocation($physicalLocation[0]);\n$relationships[0] = new LocationRelationship(1);\n$relationships[0]-&gt;addKinds(['isIncludedBy']);\n$location[0]-&gt;addRelationships([$relationships[0]]);\n\n$location[1] = new Location();\n$location[1]-&gt;setId(1);\n$artifactLocation[1] = new ArtifactLocation();\n$artifactLocation[1]-&gt;setUri('g.h');\n$physicalLocation[1] = new PhysicalLocation($artifactLocation[1]);\n$region[1] = new Region(17);\n$physicalLocation[1]-&gt;setRegion($region[1]);\n$location[1]-&gt;setPhysicalLocation($physicalLocation[1]);\n$relationships[1] = new LocationRelationship(0);\n$relationships[1]-&gt;addKinds(['includes']);\n$relationships[2] = new LocationRelationship(2);\n$relationships[2]-&gt;addKinds(['isIncludedBy']);\n$location[1]-&gt;addRelationships([$relationships[1], $relationships[2]]);\n\n$location[2] = new Location();\n$location[2]-&gt;setId(2);\n$artifactLocation[2] = new ArtifactLocation();\n$artifactLocation[2]-&gt;setUri('g.c');\n$physicalLocation[2] = new PhysicalLocation($artifactLocation[2]);\n$region[2] = new Region(8);\n$physicalLocation[2]-&gt;setRegion($region[2]);\n$location[2]-&gt;setPhysicalLocation($physicalLocation[2]);\n$relationships[2] = new LocationRelationship(1);\n$relationships[2]-&gt;addKinds(['includes']);\n$location[2]-&gt;addRelationships([$relationships[2]]);\n\n$result = new Result(new Message('A result object with locationRelationship object'));\n$result-&gt;addLocations([$location[0]]);\n$result-&gt;addRelatedLocations([$location[1], $location[2]]);\n</code></pre>"},{"location":"reference/logicalLocation/","title":"logicalLocation","text":""},{"location":"reference/logicalLocation/#logicallocation-object","title":"logicalLocation object","text":"<p>A <code>logicalLocation</code> object describes a logical location. A logical location is a location specified by a programmatic construct such as a namespace, a type, or a method, without regard to the physical location where the construct occurs.</p> <p></p>"},{"location":"reference/logicalLocation/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"Psalm\",\n                    \"version\": \"4.x-dev\",\n                    \"informationUri\": \"https://psalm.de\"\n                }\n            },\n            \"logicalLocations\": [\n                {\n                    \"name\": \"Hook\",\n                    \"fullyQualifiedName\": \"Psalm\\\\Plugin\\\\Hook\",\n                    \"kind\": \"namespace\"\n                },\n                {\n                    \"name\": \"afterAnalysis\",\n                    \"fullyQualifiedName\": \"Psalm\\\\Plugin\\\\Hook\\\\AfterAnalysisInterface\\\\afterAnalysis\",\n                    \"kind\": \"function\"\n                }\n            ],\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/logicalLocation/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/logicalLocation.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/logicalLocation.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\LogicalLocation;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$nsLocation = new LogicalLocation();\n$nsLocation-&gt;setName('Hook');\n$nsLocation-&gt;setFullyQualifiedName('Psalm\\Plugin\\Hook');\n$nsLocation-&gt;setKind('namespace');\n\n$funcLocation = new LogicalLocation();\n$funcLocation-&gt;setName('afterAnalysis');\n$funcLocation-&gt;setFullyQualifiedName('Psalm\\Plugin\\Hook\\AfterAnalysisInterface\\afterAnalysis');\n$funcLocation-&gt;setKind('function');\n\n$run = new Run($tool);\n$run-&gt;addLogicalLocations([$nsLocation, $funcLocation]);\n</code></pre>"},{"location":"reference/message/","title":"Message","text":""},{"location":"reference/message/#message-object","title":"message object","text":"<p>Certain objects in this document define messages intended to be viewed by a user. SARIF represents such a message with a <code>message</code> object, which offers the following features:</p> <ul> <li>Message strings in plain text (\u201cplain text messages\u201d).</li> <li>Message strings that incorporate formatting information (\u201cformatted messages\u201d) in GitHub Flavored Markdown.</li> <li>Message strings with placeholders for variable information.</li> <li>Message strings with embedded links.</li> </ul> <p></p>"},{"location":"reference/message/#plaintext-example","title":"PlainText Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"ESLint\",\n                    \"semanticVersion\": \"8.1.0\",\n                    \"informationUri\": \"https://eslint.org\",\n                    \"rules\": [\n                        {\n                            \"id\": \"no-unused-vars\",\n                            \"shortDescription\": {\n                                \"text\": \"disallow unused variables\"\n                            },\n                            \"helpUri\": \"https://eslint.org/docs/rules/no-unused-vars\",\n                            \"properties\": {\n                                \"category\": \"Variables\"\n                            }\n                        }\n                    ]\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"'x' is assigned a value but never used.\"\n                    },\n                    \"ruleId\": \"no-unused-vars\",\n                    \"ruleIndex\": 0,\n                    \"level\": \"error\"\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/message/#formatted-example","title":"Formatted Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Variable '{0}' is uninitialized.\",\n                        \"arguments\": [\n                            \"pBuffer\"\n                        ]\n                    },\n                    \"ruleId\": \"CA2101\"\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/message/#embedded-links-example","title":"Embedded links Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Tainted data was used. The data came from [here](3).\"\n                    },\n                    \"ruleId\": \"TNT0001\",\n                    \"relatedLocations\": [\n                        {\n                            \"id\": 3,\n                            \"physicalLocation\": {\n                                \"artifactLocation\": {\n                                    \"uri\": \"file:///C:/code/input.c\"\n                                },\n                                \"region\": {\n                                    \"startLine\": 25,\n                                    \"startColumn\": 19\n                                }\n                            }\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/message/#string-lookup-example","title":"String lookup Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CS0001\",\n                            \"messageStrings\": {\n                                \"default\": {\n                                    \"text\": \"This is the message text. It might be very long.\"\n                                }\n                            }\n                        }\n                    ]\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"id\": \"default\"\n                    },\n                    \"ruleId\": \"CS0001\",\n                    \"ruleIndex\": 0\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/message/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/message/plainText.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/plainText.php</code> script into repository.</p> <pre><code>&lt;?php\n\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$message = new Message(\"'x' is assigned a value but never used.\");\n$result = new Result($message);\n$result-&gt;setLevel('error');\n$result-&gt;setRuleId('no-unused-vars');\n$result-&gt;setRuleIndex(0);\n</code></pre> <p>See full <code>examples/message/formatted.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/formatted.php</code> script into repository.</p> <pre><code>&lt;?php\n\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$message = new Message(\"Variable '{0}' is uninitialized.\");\n$message-&gt;addArguments(['pBuffer']);\n$result = new Result($message);\n$result-&gt;setRuleId('CA2101');\n</code></pre> <p>See full <code>examples/message/embeddedLinks.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/embeddedLinks.php</code> script into repository.</p> <pre><code>&lt;?php\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Location;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\PhysicalLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$message = new Message('Tainted data was used. The data came from [here](3).');\n$result = new Result($message);\n$result-&gt;setRuleId('TNT0001');\n$location = new Location();\n$location-&gt;setId('3');\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('file:///C:/code/input.c');\n$physicalLocation = new PhysicalLocation($artifactLocation);\n$physicalLocation-&gt;setRegion(new Region(25, 19));\n$location-&gt;setPhysicalLocation($physicalLocation);\n$result-&gt;addRelatedLocations([$location]);\n</code></pre> <p>See full <code>examples/message/stringLookup.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/stringLookup.php</code> script into repository.</p> <pre><code>&lt;?php\n\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptor;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$rule = new ReportingDescriptor('no-unused-vars');\n$rule-&gt;setId('CS0001');\n$rule-&gt;addMessageStrings([\n    'default' =&gt; new MultiformatMessageString('This is the message text. It might be very long.'),\n]);\n\n$message = new Message(\n    'A message object can directly contain message strings in its text and markdown properties.'\n    . ' It can also indirectly refer to message strings through its id property.'\n);\n$result = new Result($message);\n$result-&gt;setRuleId('CS0001');\n$result-&gt;setRuleIndex(0);\n$result-&gt;setMessage(new Message('', 'default'));\n</code></pre>"},{"location":"reference/node/","title":"Node","text":""},{"location":"reference/node/#node-object","title":"node object","text":"<p>A <code>node</code> object represents a node in the graph represented by the containing graph object, which we refer to as theGraph.</p> <p></p>"},{"location":"reference/node/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"fullName\": \"CodeScanner 1.1, Developer Preview (en-US)\",\n                    \"version\": \"1.1.2b12\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Have a look on this graph\"\n                    },\n                    \"graphs\": [\n                        {\n                            \"nodes\": [\n                                {\n                                    \"id\": \"n2\"\n                                },\n                                {\n                                    \"id\": \"n3\"\n                                },\n                                {\n                                    \"id\": \"n4\"\n                                },\n                                {\n                                    \"id\": \"n1\",\n                                    \"children\": [\n                                        {\n                                            \"id\": \"n3\"\n                                        }\n                                    ]\n                                }\n                            ],\n                            \"edges\": [\n                                {\n                                    \"id\": \"e1\",\n                                    \"sourceNodeId\": \"n3\",\n                                    \"targetNodeId\": \"n4\"\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/node/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/graph.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/graph.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Edge;\nuse Bartlett\\Sarif\\Definition\\Graph;\nuse Bartlett\\Sarif\\Definition\\Node;\n\n$nodes = [];\n$nodes[2] = new Node('n2');\n$nodes[3] = new Node('n3');\n$nodes[4] = new Node('n4');\n$nodes[1] = new Node('n1');\n$nodes[1]-&gt;addChildren([$nodes[3]]);\n\n$edges = [];\n$edges[1] = new Edge('e1', 'n3', 'n4');\n\n$graph = new Graph();\n$graph-&gt;addNodes($nodes);\n$graph-&gt;addEdges($edges);\n</code></pre>"},{"location":"reference/notification/","title":"Notification","text":""},{"location":"reference/notification/#notification-object","title":"notification object","text":"<p>A <code>notification</code> object describes a condition encountered during the execution of an analysis tool which is relevant to the operation of the tool itself, as opposed to being relevant to an artifact being analyzed by the tool. Conditions relevant to artifacts being analyzed by a tool are represented by <code>result</code> objects.</p> <p></p>"},{"location":"reference/notification/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CTN9999\",\n                            \"shortDescription\": {\n                                \"text\": \"First version of rule.\"\n                            }\n                        },\n                        {\n                            \"id\": \"CTN9999\",\n                            \"shortDescription\": {\n                                \"text\": \"Second version of rule.\"\n                            }\n                        }\n                    ]\n                }\n            },\n            \"invocations\": [\n                {\n                    \"executionSuccessful\": true,\n                    \"toolExecutionNotifications\": [\n                        {\n                            \"message\": {\n                                \"text\": \"Exception evaluating rule 'C2001'. Rule configuration is missing.\"\n                            },\n                            \"level\": \"error\",\n                            \"descriptor\": {\n                                \"index\": 1,\n                                \"id\": \"CTN9999\"\n                            }\n                        }\n                    ]\n                }\n            ],\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CTN9999\"\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/notification/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/reportingDescriptorReference.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/reportingDescriptorReference.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Invocation;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Notification;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptorReference;\n\n$notification = new Notification(new Message(\"Exception evaluating rule 'C2001'. Rule configuration is missing.\"));\n$notification-&gt;setAssociatedRule(new ReportingDescriptorReference(0, 'C2001'));\n$notification-&gt;setDescriptor(new ReportingDescriptorReference(1, 'CTN9999'));\n$notification-&gt;setLevel('error');\n$invocation = new Invocation(true);\n$invocation-&gt;addToolExecutionNotifications([$notification]);\n</code></pre>"},{"location":"reference/physicalLocation/","title":"physicalLocation","text":""},{"location":"reference/physicalLocation/#physicallocation-object","title":"physicalLocation object","text":"<p>A <code>physicalLocation</code> object represents the physical location where a result was detected. A physical location specifies a reference to an artifact together with a region within that artifact.</p> <p></p>"},{"location":"reference/physicalLocation/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Identify a physical location where a result was detected.\"\n                    },\n                    \"locations\": [\n                        {\n                            \"physicalLocation\": {\n                                \"artifactLocation\": {\n                                    \"uri\": \"ui/window.c\",\n                                    \"uriBaseId\": \"SRCROOT\"\n                                },\n                                \"region\": {\n                                    \"startLine\": 42\n                                }\n                            }\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/physicalLocation/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/physicalLocation.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/physicalLocation.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Location;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\PhysicalLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('ui/window.c');\n$artifactLocation-&gt;setUriBaseId('SRCROOT');\n\n$result = new Result(new Message('Identify a physical location where a result was detected.'));\n$location = new Location();\n$physicalLocation = new PhysicalLocation($artifactLocation);\n$physicalLocation-&gt;setRegion(new Region(42));\n$location-&gt;setPhysicalLocation($physicalLocation);\n$result-&gt;addLocations([$location]);\n</code></pre>"},{"location":"reference/rectangle/","title":"Rectangle","text":""},{"location":"reference/rectangle/#rectangle-object","title":"rectangle object","text":"<p>A <code>rectangle</code> object specifies a rectangular area within an image. When a SARIF viewer displays an image, it MAY indicate the presence of these areas, for example, by highlighting them or surrounding them with a border.</p> <p></p>"},{"location":"reference/rectangle/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"fullName\": \"CodeScanner 1.1, Developer Preview (en-US)\",\n                    \"version\": \"1.1.2b12\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Have a look on screen shot provided\"\n                    },\n                    \"attachments\": [\n                        {\n                            \"artifactLocation\": {\n                                \"uri\": \"file:///C:/ScanOutput/image001.png\"\n                            },\n                            \"description\": {\n                                \"text\": \"Screen shot\"\n                            },\n                            \"rectangles\": [\n                                {\n                                    \"top\": 80,\n                                    \"left\": 10,\n                                    \"bottom\": 5,\n                                    \"right\": 90\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/rectangle/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/rectangle.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/rectangle.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Attachment;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Rectangle;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$attachment = new Attachment();\n$attachment-&gt;setDescription(new Message('Screen shot'));\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('file:///C:/ScanOutput/image001.png');\n$attachment-&gt;setArtifactLocation($artifactLocation);\n$rectangle = new Rectangle();\n$rectangle-&gt;setTop(80);\n$rectangle-&gt;setLeft(10);\n$rectangle-&gt;setBottom(5);\n$rectangle-&gt;setRight(90);\n$attachment-&gt;addRectangles([$rectangle]);\n\n$result = new Result(new Message('Have a look on screen shot provided'));\n$result-&gt;addAttachments([$attachment]);\n</code></pre>"},{"location":"reference/replacement/","title":"Replacement","text":""},{"location":"reference/replacement/#replacement-object","title":"replacement object","text":"<p>A <code>replacement</code> object represents the replacement of a single region of an artifact.</p> <p></p>"},{"location":"reference/replacement/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CA1001\",\n                    \"fixes\": [\n                        {\n                            \"artifactChanges\": [\n                                {\n                                    \"artifactLocation\": {\n                                        \"uri\": \"src/a.c\"\n                                    },\n                                    \"replacements\": [\n                                        {\n                                            \"deletedRegion\": {\n                                                \"startLine\": 1,\n                                                \"startColumn\": 1,\n                                                \"endLine\": 1\n                                            },\n                                            \"insertedContent\": {\n                                                \"text\": \"// \"\n                                            }\n                                        }\n                                    ]\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/replacement/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/fix.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/fix.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactChange;\nuse Bartlett\\Sarif\\Definition\\ArtifactContent;\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Replacement;\n\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('src/a.c');\n$replacement = new Replacement(new Region(1, 1, 1));\n$insertedContent = new ArtifactContent();\n$insertedContent-&gt;setText('// ');\n$replacement-&gt;setInsertedContent($insertedContent);\n$artifactChange = new ArtifactChange($artifactLocation, [$replacement]);\n</code></pre>"},{"location":"reference/reportingConfiguration/","title":"reportingConfiguration","text":""},{"location":"reference/reportingConfiguration/#reportingconfiguration-object","title":"reportingConfiguration object","text":"<p>A <code>reportingConfiguration</code> object contains the information in a <code>reportingDescriptor</code> that a SARIF producer can modify at runtime, before executing its scan.</p> <p></p>"},{"location":"reference/reportingConfiguration/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"SA2707\",\n                            \"name\": \"LimitSourceLineLength\",\n                            \"shortDescription\": {\n                                \"text\": \"Limit source line length for readability.\"\n                            },\n                            \"defaultConfiguration\": {\n                                \"enabled\": true,\n                                \"level\": \"warning\",\n                                \"rank\": -1,\n                                \"parameters\": {\n                                    \"maxLength\": 120\n                                }\n                            }\n                        }\n                    ]\n                }\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/reportingConfiguration/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/reportingConfiguration.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/reportingConfiguration.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\PropertyBag;\nuse Bartlett\\Sarif\\Definition\\ReportingConfiguration;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptor;\n\n$rule = new ReportingDescriptor('SA2707');\n$rule-&gt;setName('LimitSourceLineLength');\n$rule-&gt;setShortDescription(new MultiformatMessageString('Limit source line length for readability.'));\n$reportingConf = new ReportingConfiguration();\n$propertyBag = new PropertyBag();\n$propertyBag-&gt;addProperty('maxLength', 120);\n$reportingConf-&gt;setParameters($propertyBag);\n$rule-&gt;setDefaultConfiguration($reportingConf);\n</code></pre>"},{"location":"reference/reportingDescriptor/","title":"reportingDescriptor","text":""},{"location":"reference/reportingDescriptor/#reportingdescriptor-object","title":"reportingDescriptor object","text":"<p>A <code>reportingDescriptor</code> object contains information that describes a \"reporting item\" generated by a tool.</p> <p></p>"},{"location":"reference/reportingDescriptor/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CA1001\",\n                            \"deprecatedIds\": [\n                                \"CA1000\"\n                            ]\n                        },\n                        {\n                            \"id\": \"CA1002\",\n                            \"deprecatedIds\": [\n                                \"CA1000\"\n                            ]\n                        }\n                    ]\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CA1001\",\n                    \"suppressions\": [\n                        {\n                            \"kind\": \"inSource\"\n                        }\n                    ],\n                    \"baselineState\": \"unchanged\"\n                },\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CA1002\",\n                    \"suppressions\": [\n                        {\n                            \"kind\": \"inSource\"\n                        }\n                    ],\n                    \"baselineState\": \"updated\"\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/reportingDescriptor/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/reportingDescriptor.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/reportingDescriptor.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptor;\nuse Bartlett\\Sarif\\Definition\\ToolComponent;\n\n$driver = new ToolComponent('CodeScanner');\n\n$rule1 = new ReportingDescriptor('CA1001');\n$rule1-&gt;addDeprecatedIds(['CA1000']);\n$rule2 = new ReportingDescriptor('CA1002');\n$rule2-&gt;addDeprecatedIds(['CA1000']);\n$driver-&gt;addRules([$rule1, $rule2]);\n</code></pre>"},{"location":"reference/reportingDescriptorReference/","title":"reportingDescriptorReference","text":""},{"location":"reference/reportingDescriptorReference/#reportingdescriptorreference-object","title":"reportingDescriptorReference object","text":"<p>A <code>reportingDescriptorReference</code> object identifies a particular <code>reportingDescriptor</code> object, which we refer to as theDescriptor, among all <code>reportingDescriptor</code> objects defined by theTool, including those defined by theTool.driver and theTool.extensions.</p> <p></p>"},{"location":"reference/reportingDescriptorReference/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CTN9999\",\n                            \"shortDescription\": {\n                                \"text\": \"First version of rule.\"\n                            }\n                        },\n                        {\n                            \"id\": \"CTN9999\",\n                            \"shortDescription\": {\n                                \"text\": \"Second version of rule.\"\n                            }\n                        }\n                    ]\n                }\n            },\n            \"invocations\": [\n                {\n                    \"executionSuccessful\": true,\n                    \"toolExecutionNotifications\": [\n                        {\n                            \"message\": {\n                                \"text\": \"Exception evaluating rule 'C2001'. Rule configuration is missing.\"\n                            },\n                            \"level\": \"error\",\n                            \"descriptor\": {\n                                \"index\": 1,\n                                \"id\": \"CTN9999\"\n                            }\n                        }\n                    ]\n                }\n            ],\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CTN9999\"\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/reportingDescriptorReference/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/reportingDescriptorReference.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/reportingDescriptorReference.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Invocation;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Notification;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptorReference;\n\n$notification = new Notification(new Message(\"Exception evaluating rule 'C2001'. Rule configuration is missing.\"));\n$notification-&gt;setAssociatedRule(new ReportingDescriptorReference(0, 'C2001'));\n$notification-&gt;setDescriptor(new ReportingDescriptorReference(1, 'CTN9999'));\n$notification-&gt;setLevel('error');\n$invocation = new Invocation(true);\n$invocation-&gt;addToolExecutionNotifications([$notification]);\n</code></pre>"},{"location":"reference/reportingDescriptorRelationship/","title":"reportingDescriptorRelationship","text":""},{"location":"reference/reportingDescriptorRelationship/#reportingdescriptorrelationship-object","title":"reportingDescriptorRelationship object","text":"<p>A <code>reportingDescriptorRelationship</code> object specifies one or more directed relationships from one <code>reportingDescriptor</code> object, which we refer to as theSource, to another one, which we refer to as theTarget.</p> <p></p>"},{"location":"reference/reportingDescriptorRelationship/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CA1000\",\n                            \"relationships\": [\n                                {\n                                    \"target\": {\n                                        \"index\": 0,\n                                        \"id\": \"327\",\n                                        \"guid\": \"33333333-0000-1111-8888-111111111111\",\n                                        \"toolComponent\": {\n                                            \"name\": \"CWE\",\n                                            \"guid\": \"33333333-0000-1111-8888-000000000000\"\n                                        }\n                                    },\n                                    \"kinds\": [\n                                        \"superset\"\n                                    ]\n                                }\n                            ]\n                        }\n                    ]\n                }\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/reportingDescriptorRelationship/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/reportingDescriptorRelationship.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/reportingDescriptorRelationship.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptor;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptorReference;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptorRelationship;\nuse Bartlett\\Sarif\\Definition\\ToolComponentReference;\n\n$rule = new ReportingDescriptor('CA1000');\n\n$target = new ReportingDescriptorReference(0, '327', '33333333-0000-1111-8888-111111111111');\n$toolComponent = new ToolComponentReference();\n$toolComponent-&gt;setName('CWE');\n$toolComponent-&gt;setGuid('33333333-0000-1111-8888-000000000000');\n$target-&gt;setToolComponent($toolComponent);\n\n$relationship = new ReportingDescriptorRelationship($target);\n$relationship-&gt;addKinds(['superset']);\n$rule-&gt;addRelationships([$relationship]);\n</code></pre>"},{"location":"reference/result/","title":"Result","text":""},{"location":"reference/result/#result-object","title":"result object","text":"<p>A <code>result</code> object describes a single result detected by an analysis tool.</p> <p></p>"},{"location":"reference/result/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CA2101\",\n                            \"shortDescription\": {\n                                \"text\": \"Specify marshaling for P/Invoke string arguments.\"\n                            }\n                        },\n                        {\n                            \"id\": \"CA5350\",\n                            \"shortDescription\": {\n                                \"text\": \"Do not use weak cryptographic algorithms.\"\n                            }\n                        }\n                    ]\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Result on rule 0\"\n                    },\n                    \"ruleId\": \"CA2101\",\n                    \"ruleIndex\": 0\n                },\n                {\n                    \"message\": {\n                        \"text\": \"Result on rule 1\"\n                    },\n                    \"ruleId\": \"CA5350/md5\",\n                    \"ruleIndex\": 1\n                },\n                {\n                    \"message\": {\n                        \"text\": \"Another result on rule 1\"\n                    },\n                    \"ruleId\": \"CA5350/sha-1\",\n                    \"ruleIndex\": 1\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/result/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/result.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/result.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Result;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$result1 = new Result(new Message('Result on rule 0'));\n$result1-&gt;setRuleId('CA2101');\n$result1-&gt;setRuleIndex(0);\n\n$result2 = new Result(new Message('Result on rule 1'));\n$result2-&gt;setRuleId('CA5350/md5');\n$result2-&gt;setRuleIndex(1);\n\n$result3 = new Result(new Message('Another result on rule 1'));\n$result3-&gt;setRuleId('CA5350/sha-1');\n$result3-&gt;setRuleIndex(1);\n\n$run = new Run($tool);\n$run-&gt;addResults([$result1, $result2, $result3]);\n</code></pre>"},{"location":"reference/resultProvenance/","title":"resultProvenance","text":""},{"location":"reference/resultProvenance/#resultprovenance-object","title":"resultProvenance object","text":"<p>A <code>resultProvenance</code> object contains information about the how and when theResult was detected.</p> <p></p>"},{"location":"reference/resultProvenance/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"SarifSamples\",\n                    \"version\": \"1.0\",\n                    \"informationUri\": \"https://github.com/microsoft/sarif-tutorials/\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Assertions are unreliable.\"\n                    },\n                    \"ruleId\": \"Assertions\",\n                    \"provenance\": {\n                        \"conversionSources\": [\n                            {\n                                \"artifactLocation\": {\n                                    \"uri\": \"CodeScanner.log\",\n                                    \"uriBaseId\": \"LOGSROOT\"\n                                },\n                                \"region\": {\n                                    \"startLine\": 3,\n                                    \"startColumn\": 3,\n                                    \"endLine\": 12,\n                                    \"endColumn\": 13,\n                                    \"snippet\": {\n                                        \"text\": \"&lt;problem&gt;...&lt;/problem&gt;\"\n                                    }\n                                }\n                            }\n                        ]\n                    }\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/resultProvenance/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/resultProvenance.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/resultProvenance.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactContent;\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\PhysicalLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Result;\nuse Bartlett\\Sarif\\Definition\\ResultProvenance;\n\n$provenance = new ResultProvenance();\n$fromSources = [];\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('CodeScanner.log');\n$artifactLocation-&gt;setUriBaseId('LOGSROOT');\n$fromSources[0] = new PhysicalLocation($artifactLocation);\n$region = new Region(3, 3, 12, 13);\n$snippet = new ArtifactContent();\n$snippet-&gt;setText('&lt;problem&gt;...&lt;/problem&gt;');\n$region-&gt;setSnippet($snippet);\n$fromSources[0]-&gt;setRegion($region);\n\n$provenance-&gt;addConversionSources($fromSources);\n\n$result = new Result(new Message('Assertions are unreliable.'));\n$result-&gt;setProvenance($provenance);\n</code></pre>"},{"location":"reference/run/","title":"Run","text":""},{"location":"reference/run/#run-object","title":"run object","text":"<p>A <code>run</code> object describes a single run of an analysis tool and contains the output of that run.</p> <p></p>"},{"location":"reference/run/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"Psalm\",\n                    \"version\": \"4.x-dev\",\n                    \"informationUri\": \"https://psalm.de\"\n                }\n            },\n            \"properties\": {\n                \"stableId\": \"Nightly static analysis run\"\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/run/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/run.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/run.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Run;\nuse Bartlett\\Sarif\\Definition\\Tool;\nuse Bartlett\\Sarif\\Definition\\ToolComponent;\n\n$driver = new ToolComponent('Psalm');\n$tool = new Tool($driver);\n\n$run = new Run($tool);\n</code></pre>"},{"location":"reference/runAutomationDetails/","title":"runAutomationDetails","text":""},{"location":"reference/runAutomationDetails/#runautomationdetails-object","title":"runAutomationDetails object","text":"<p>A <code>runAutomationDetails</code> object contains information that specifies theRun\u2019s identity and role within an engineering system.</p> <p></p>"},{"location":"reference/runAutomationDetails/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"fullName\": \"CodeScanner 1.1, Developer Preview (en-US)\",\n                    \"version\": \"1.1.2b12\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"automationDetails\": {\n                \"description\": {\n                    \"text\": \"This is the {0} nightly run of the Credential Scanner tool on all product binaries in the '{1}' branch of the '{2}' repo. The scanned binaries are architecture '{3}' and build type '{4}'.\",\n                    \"arguments\": [\n                        \"October 10, 2018\",\n                        \"master\",\n                        \"sarif-sdk\",\n                        \"x86\",\n                        \"debug\"\n                    ]\n                },\n                \"id\": \"Nightly CredScan run for sarif-sdk/master/x86/debug/2018-10-05\",\n                \"guid\": \"11111111-1111-1111-8888-111111111111\",\n                \"correlationGuid\": \"22222222-2222-1111-8888-222222222222\"\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/runAutomationDetails/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/runAutomationDetails.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/runAutomationDetails.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Run;\nuse Bartlett\\Sarif\\Definition\\RunAutomationDetails;\n\n$automationDetails = new RunAutomationDetails();\n\n$text = \"This is the {0} nightly run of the Credential Scanner tool on\" .\n    \" all product binaries in the '{1}' branch of the '{2}' repo.\".\n    \" The scanned binaries are architecture '{3}' and build type '{4}'.\";\n$description = new Message($text);\n$description-&gt;addArguments([\n    \"October 10, 2018\",\n    \"master\",\n    \"sarif-sdk\",\n    \"x86\",\n    \"debug\",\n]);\n$automationDetails-&gt;setDescription($description);\n$automationDetails-&gt;setId('Nightly CredScan run for sarif-sdk/master/x86/debug/2018-10-05');\n$automationDetails-&gt;setGuid('11111111-1111-1111-8888-111111111111');\n$automationDetails-&gt;setCorrelationGuid('22222222-2222-1111-8888-222222222222');\n\n$run = new Run($tool);\n$run-&gt;setAutomationDetails($automationDetails);\n</code></pre>"},{"location":"reference/sarifLog/","title":"sarifLog","text":""},{"location":"reference/sarifLog/#sariflog-object","title":"sarifLog object","text":"<p>A <code>sarifLog</code> object specifies the version of the file format and contains the output from one or more runs.</p> <p></p>"},{"location":"reference/sarifLog/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": []\n}\n</code></pre>"},{"location":"reference/sarifLog/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/sarifLog.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/sarifLog.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\SarifLog;\n\n$log = new SarifLog();\n</code></pre>"},{"location":"reference/specialLocations/","title":"specialLocations","text":""},{"location":"reference/specialLocations/#speciallocations-object","title":"specialLocations object","text":"<p>A <code>specialLocations</code> object defines locations of special significance to SARIF consumers.</p> <p></p>"},{"location":"reference/specialLocations/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"originalUriBaseIds\": {\n                \"WEBHOST\": {\n                    \"uri\": \"http://www.example.com/\"\n                },\n                \"ROOT\": {\n                    \"uri\": \"file:///\"\n                },\n                \"HOME\": {\n                    \"uri\": \"home/user/\",\n                    \"uriBaseId\": \"ROOT\"\n                },\n                \"PACKAGE\": {\n                    \"uri\": \"mySoftware/\",\n                    \"uriBaseId\": \"HOME\"\n                },\n                \"SRC\": {\n                    \"uri\": \"src/\",\n                    \"uriBaseId\": \"PACKAGE\"\n                }\n            },\n            \"specialLocations\": {\n                \"displayBase\": {\n                    \"uriBaseId\": \"PACKAGE\"\n                }\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/specialLocations/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/specialLocations.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/specialLocations.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Run;\nuse Bartlett\\Sarif\\Definition\\SpecialLocations;\n\n$package = new ArtifactLocation();\n$package-&gt;setUri('mySoftware/');\n$package-&gt;setUriBaseId('HOME');\n\n$run = new Run($tool);\n$run-&gt;addAdditionalProperties([\n    'PACKAGE' =&gt; $package,\n]);\n\n$specialLocations = new SpecialLocations();\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('');\n$artifactLocation-&gt;setUriBaseId('PACKAGE');\n$specialLocations-&gt;setDisplayBase($artifactLocation);\n\n$run-&gt;setSpecialLocations($specialLocations);\n</code></pre>"},{"location":"reference/stack/","title":"Stack","text":""},{"location":"reference/stack/#stack-object","title":"stack object","text":"<p>A <code>stack</code> object describes a single call stack. A call stack is a sequence of nested function calls, each of which is referred to as a stack frame.</p> <p></p>"},{"location":"reference/stack/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"SarifSamples\",\n                    \"version\": \"1.0\",\n                    \"informationUri\": \"https://github.com/microsoft/sarif-tutorials/\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Uninitialized variable.\"\n                    },\n                    \"ruleId\": \"TUT1001\",\n                    \"locations\": [\n                        {\n                            \"physicalLocation\": {\n                                \"artifactLocation\": {\n                                    \"uri\": \"collections/list.h\",\n                                    \"uriBaseId\": \"SRCROOT\"\n                                },\n                                \"region\": {\n                                    \"startLine\": 15\n                                }\n                            },\n                            \"logicalLocations\": [\n                                {\n                                    \"fullyQualifiedName\": \"collections::list::add\"\n                                }\n                            ]\n                        }\n                    ],\n                    \"stacks\": [\n                        {\n                            \"frames\": [\n                                {\n                                    \"location\": {\n                                        \"physicalLocation\": {\n                                            \"artifactLocation\": {\n                                                \"uri\": \"collections/list.h\",\n                                                \"uriBaseId\": \"SRCROOT\"\n                                            },\n                                            \"region\": {\n                                                \"startLine\": 110,\n                                                \"startColumn\": 15\n                                            }\n                                        },\n                                        \"logicalLocations\": [\n                                            {\n                                                \"fullyQualifiedName\": \"collections::list::add_core\"\n                                            }\n                                        ]\n                                    },\n                                    \"module\": \"platform\",\n                                    \"threadId\": 52,\n                                    \"parameters\": [\n                                        \"null\",\n                                        \"0\",\n                                        \"14\"\n                                    ]\n                                }\n                            ],\n                            \"message\": {\n                                \"text\": \"Call stack resulting from usage of uninitialized variable.\"\n                            }\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/stack/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/stack.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/stack.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Location;\nuse Bartlett\\Sarif\\Definition\\LogicalLocation;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\PhysicalLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Stack;\nuse Bartlett\\Sarif\\Definition\\StackFrame;\n\n$frame = new StackFrame();\n\n$location = new Location();\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('collections/list.h');\n$artifactLocation-&gt;setUriBaseId('SRCROOT');\n$physicalLocation = new PhysicalLocation($artifactLocation);\n$physicalLocation-&gt;setRegion(new Region(110, 15));\n$location-&gt;setPhysicalLocation($physicalLocation);\n$logicalLocation = new LogicalLocation();\n$logicalLocation-&gt;setFullyQualifiedName('collections::list::add_core');\n$location-&gt;addLogicalLocations([$logicalLocation]);\n$frame-&gt;setLocation($location);\n$frame-&gt;setModule('platform');\n$frame-&gt;setThreadId(52);\n$frame-&gt;addParameters(['null', '0', '14']);\n\n$stack = new Stack([$frame]);\n$stack-&gt;setMessage(new Message('Call stack resulting from usage of uninitialized variable.'));\n</code></pre>"},{"location":"reference/stackFrame/","title":"stackFrame","text":""},{"location":"reference/stackFrame/#stackframe-object","title":"stackFrame object","text":"<p>A <code>stackFrame</code> object describes a single stack frame within a call stack.</p> <p></p>"},{"location":"reference/stackFrame/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"SarifSamples\",\n                    \"version\": \"1.0\",\n                    \"informationUri\": \"https://github.com/microsoft/sarif-tutorials/\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Uninitialized variable.\"\n                    },\n                    \"ruleId\": \"TUT1001\",\n                    \"locations\": [\n                        {\n                            \"physicalLocation\": {\n                                \"artifactLocation\": {\n                                    \"uri\": \"collections/list.h\",\n                                    \"uriBaseId\": \"SRCROOT\"\n                                },\n                                \"region\": {\n                                    \"startLine\": 15\n                                }\n                            },\n                            \"logicalLocations\": [\n                                {\n                                    \"fullyQualifiedName\": \"collections::list::add\"\n                                }\n                            ]\n                        }\n                    ],\n                    \"stacks\": [\n                        {\n                            \"frames\": [\n                                {\n                                    \"location\": {\n                                        \"physicalLocation\": {\n                                            \"artifactLocation\": {\n                                                \"uri\": \"collections/list.h\",\n                                                \"uriBaseId\": \"SRCROOT\"\n                                            },\n                                            \"region\": {\n                                                \"startLine\": 110,\n                                                \"startColumn\": 15\n                                            }\n                                        },\n                                        \"logicalLocations\": [\n                                            {\n                                                \"fullyQualifiedName\": \"collections::list::add_core\"\n                                            }\n                                        ]\n                                    },\n                                    \"module\": \"platform\",\n                                    \"threadId\": 52,\n                                    \"parameters\": [\n                                        \"null\",\n                                        \"0\",\n                                        \"14\"\n                                    ]\n                                }\n                            ],\n                            \"message\": {\n                                \"text\": \"Call stack resulting from usage of uninitialized variable.\"\n                            }\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/stackFrame/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/stack.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/stack.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Location;\nuse Bartlett\\Sarif\\Definition\\LogicalLocation;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\PhysicalLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Stack;\nuse Bartlett\\Sarif\\Definition\\StackFrame;\n\n$frame = new StackFrame();\n\n$location = new Location();\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('collections/list.h');\n$artifactLocation-&gt;setUriBaseId('SRCROOT');\n$physicalLocation = new PhysicalLocation($artifactLocation);\n$physicalLocation-&gt;setRegion(new Region(110, 15));\n$location-&gt;setPhysicalLocation($physicalLocation);\n$logicalLocation = new LogicalLocation();\n$logicalLocation-&gt;setFullyQualifiedName('collections::list::add_core');\n$location-&gt;addLogicalLocations([$logicalLocation]);\n$frame-&gt;setLocation($location);\n$frame-&gt;setModule('platform');\n$frame-&gt;setThreadId(52);\n$frame-&gt;addParameters(['null', '0', '14']);\n\n$stack = new Stack([$frame]);\n$stack-&gt;setMessage(new Message('Call stack resulting from usage of uninitialized variable.'));\n</code></pre>"},{"location":"reference/suppression/","title":"Suppression","text":""},{"location":"reference/suppression/#suppression-object","title":"suppression object","text":"<p>A <code>suppression</code> object describes a request to suppress a result.</p> <p></p>"},{"location":"reference/suppression/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"Psalm\",\n                    \"version\": \"4.x-dev\",\n                    \"informationUri\": \"https://psalm.de\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Request to suppress a result\"\n                    },\n                    \"suppressions\": [\n                        {\n                            \"kind\": \"inSource\",\n                            \"guid\": \"11111111-1111-1111-8888-111111111111\",\n                            \"status\": \"underReview\",\n                            \"justification\": \"result outdated\"\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/suppression/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/suppression.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/suppression.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Result;\nuse Bartlett\\Sarif\\Definition\\Suppression;\n\n$suppression = new Suppression('inSource');\n$suppression-&gt;setGuid('11111111-1111-1111-8888-111111111111');\n$suppression-&gt;setStatus('underReview');\n$suppression-&gt;setJustification('result outdated');\n\n$result = new Result(new Message('Request to suppress a result'));\n$result-&gt;addSuppressions([$suppression]);\n</code></pre>"},{"location":"reference/threadFlow/","title":"threadFlow","text":""},{"location":"reference/threadFlow/#threadflow-object","title":"threadFlow object","text":"<p>A <code>threadFlow</code> object is a sequence of code locations that specify a possible path through a single thread of execution such as an operating system thread or a fiber.</p> <p></p>"},{"location":"reference/threadFlow/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"A result object\"\n                    },\n                    \"codeFlows\": [\n                        {\n                            \"threadFlows\": [\n                                {\n                                    \"locations\": [\n                                        {\n                                            \"location\": {\n                                                \"physicalLocation\": {\n                                                    \"artifactLocation\": {\n                                                        \"uri\": \"ui/window.c\",\n                                                        \"uriBaseId\": \"SRCROOT\"\n                                                    },\n                                                    \"region\": {\n                                                        \"startLine\": 42\n                                                    }\n                                                }\n                                            },\n                                            \"state\": {\n                                                \"x\": {\n                                                    \"text\": \"42\"\n                                                },\n                                                \"y\": {\n                                                    \"text\": \"54\"\n                                                },\n                                                \"x+y\": {\n                                                    \"text\": \"96\"\n                                                }\n                                            },\n                                            \"nestingLevel\": 0,\n                                            \"executionOrder\": 2\n                                        }\n                                    ],\n                                    \"id\": \"thread-123\",\n                                    \"message\": {\n                                        \"text\": \"A threadFlow object\"\n                                    }\n                                }\n                            ],\n                            \"message\": {\n                                \"text\": \"A codeFlow object\"\n                            }\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/threadFlow/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/codeFlow.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/codeFlow.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Location;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\PhysicalLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\ThreadFlow;\nuse Bartlett\\Sarif\\Definition\\ThreadFlowLocation;\n\n$threadFlowLocation = new ThreadFlowLocation();\n$location = new Location();\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('ui/window.c');\n$artifactLocation-&gt;setUriBaseId('SRCROOT');\n$physicalLocation = new PhysicalLocation($artifactLocation);\n$physicalLocation-&gt;setRegion(new Region(42));\n$location-&gt;setPhysicalLocation($physicalLocation);\n$threadFlowLocation-&gt;setLocation($location);\n$threadFlowLocation-&gt;addAdditionalProperties([\n    'x' =&gt; new MultiformatMessageString('42'),\n    'y' =&gt; new MultiformatMessageString('54'),\n    'x+y' =&gt; new MultiformatMessageString('96'),\n]);\n$threadFlowLocation-&gt;setNestingLevel(0);\n$threadFlowLocation-&gt;setExecutionOrder(2);\n\n$threadFlow = new ThreadFlow([$threadFlowLocation]);\n$threadFlow-&gt;setId('thread-123');\n$threadFlow-&gt;setMessage(new Message('A threadFlow object'));\n</code></pre>"},{"location":"reference/threadFlowLocation/","title":"threadFlowLocation","text":""},{"location":"reference/threadFlowLocation/#threadflowlocation-object","title":"threadFlowLocation object","text":"<p>A <code>threadFlowLocation</code> object represents a location visited by an analysis tool in the course of simulating or monitoring the execution of a program.</p> <p></p>"},{"location":"reference/threadFlowLocation/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"A result object\"\n                    },\n                    \"codeFlows\": [\n                        {\n                            \"threadFlows\": [\n                                {\n                                    \"locations\": [\n                                        {\n                                            \"location\": {\n                                                \"physicalLocation\": {\n                                                    \"artifactLocation\": {\n                                                        \"uri\": \"ui/window.c\",\n                                                        \"uriBaseId\": \"SRCROOT\"\n                                                    },\n                                                    \"region\": {\n                                                        \"startLine\": 42\n                                                    }\n                                                }\n                                            },\n                                            \"state\": {\n                                                \"x\": {\n                                                    \"text\": \"42\"\n                                                },\n                                                \"y\": {\n                                                    \"text\": \"54\"\n                                                },\n                                                \"x+y\": {\n                                                    \"text\": \"96\"\n                                                }\n                                            },\n                                            \"nestingLevel\": 0,\n                                            \"executionOrder\": 2\n                                        }\n                                    ],\n                                    \"id\": \"thread-123\",\n                                    \"message\": {\n                                        \"text\": \"A threadFlow object\"\n                                    }\n                                }\n                            ],\n                            \"message\": {\n                                \"text\": \"A codeFlow object\"\n                            }\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/threadFlowLocation/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/codeFlow.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/codeFlow.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Location;\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\PhysicalLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\ThreadFlowLocation;\n\n$threadFlowLocation = new ThreadFlowLocation();\n$location = new Location();\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('ui/window.c');\n$artifactLocation-&gt;setUriBaseId('SRCROOT');\n$physicalLocation = new PhysicalLocation($artifactLocation);\n$physicalLocation-&gt;setRegion(new Region(42));\n$location-&gt;setPhysicalLocation($physicalLocation);\n$threadFlowLocation-&gt;setLocation($location);\n$threadFlowLocation-&gt;addAdditionalProperties([\n    'x' =&gt; new MultiformatMessageString('42'),\n    'y' =&gt; new MultiformatMessageString('54'),\n    'x+y' =&gt; new MultiformatMessageString('96'),\n]);\n$threadFlowLocation-&gt;setNestingLevel(0);\n$threadFlowLocation-&gt;setExecutionOrder(2);\n</code></pre>"},{"location":"reference/tool/","title":"Tool","text":""},{"location":"reference/tool/#tool-object","title":"tool object","text":"<p>A <code>tool</code> object describes the analysis tool or converter that was run.</p> <p></p>"},{"location":"reference/tool/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"fullName\": \"CodeScanner 1.1, Developer Preview (en-US)\",\n                    \"version\": \"1.1.2b12\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                },\n                \"extensions\": [\n                    {\n                        \"name\": \"CodeScanner Security Rules\",\n                        \"version\": \"3.1\"\n                    }\n                ]\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/tool/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/tool.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/tool.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Tool;\nuse Bartlett\\Sarif\\Definition\\ToolComponent;\n\n$driver = new ToolComponent('CodeScanner');\n\n$tool = new Tool($driver);\n</code></pre>"},{"location":"reference/toolComponentReference/","title":"toolComponentReference","text":""},{"location":"reference/toolComponentReference/#toolcomponentreference-object","title":"toolComponentReference object","text":"<p>A <code>toolComponentReference</code> object identifies a particular <code>toolComponent</code> object, either theTool.driver or an element of theTool.extensions. We refer to the identified toolComponent object as theComponent.</p> <p></p>"},{"location":"reference/toolComponentReference/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CA1000\",\n                            \"relationships\": [\n                                {\n                                    \"target\": {\n                                        \"index\": 0,\n                                        \"id\": \"327\",\n                                        \"guid\": \"33333333-0000-1111-8888-111111111111\",\n                                        \"toolComponent\": {\n                                            \"name\": \"CWE\",\n                                            \"guid\": \"33333333-0000-1111-8888-000000000000\"\n                                        }\n                                    },\n                                    \"kinds\": [\n                                        \"superset\"\n                                    ]\n                                }\n                            ]\n                        }\n                    ]\n                }\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/toolComponentReference/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/reportingDescriptorRelationship.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/reportingDescriptorRelationship.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptor;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptorReference;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptorRelationship;\nuse Bartlett\\Sarif\\Definition\\Run;\nuse Bartlett\\Sarif\\Definition\\Tool;\nuse Bartlett\\Sarif\\Definition\\ToolComponent;\nuse Bartlett\\Sarif\\Definition\\ToolComponentReference;\nuse Bartlett\\Sarif\\SarifLog;\n\n$target = new ReportingDescriptorReference(0, '327', '33333333-0000-1111-8888-111111111111');\n$toolComponent = new ToolComponentReference();\n$toolComponent-&gt;setName('CWE');\n$toolComponent-&gt;setGuid('33333333-0000-1111-8888-000000000000');\n$target-&gt;setToolComponent($toolComponent);\n</code></pre>"},{"location":"reference/translationMetadata/","title":"translationMetadata","text":""},{"location":"reference/translationMetadata/#translationmetadata-object","title":"translationMetadata object","text":"<p>A <code>translationMetadata</code> object defines locations of special significance to SARIF consumers.</p> <p></p>"},{"location":"reference/translationMetadata/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"(fr-FR translation)\",\n                    \"fullName\": \"(fr-FR translation of translated component\\u2019s full name)\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"language\": \"fr-FR\",\n                    \"translationMetadata\": {\n                        \"name\": \"CodeScanner translation for fr-FR\",\n                        \"fullName\": \"CodeScanner translation for fr-FR by Example Corp.\",\n                        \"shortDescription\": {\n                            \"text\": \"A good translation\"\n                        },\n                        \"fullDescription\": {\n                            \"text\": \"A good translation performed by native en-US speakers.\"\n                        }\n                    }\n                }\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/translationMetadata/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/translationMetadata.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/translationMetadata.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\ToolComponent;\nuse Bartlett\\Sarif\\Definition\\TranslationMetadata;\n\n$driver = new ToolComponent('CodeScanner');\n\n$translationMetadata = new TranslationMetadata('CodeScanner translation for fr-FR');\n$translationMetadata-&gt;setFullName('CodeScanner translation for fr-FR by Example Corp.');\n$translationMetadata-&gt;setShortDescription(\n    new MultiformatMessageString('A good translation')\n);\n$translationMetadata-&gt;setFullDescription(\n    new MultiformatMessageString('A good translation performed by native en-US speakers.')\n);\n$driver-&gt;setTranslationMetadata($translationMetadata);\n\n$driver-&gt;setName('(fr-FR translation)');\n$driver-&gt;setFullName('(fr-FR translation of translated component\u2019s full name)');\n</code></pre>"},{"location":"reference/versionControlDetails/","title":"versionControlDetails","text":""},{"location":"reference/versionControlDetails/#versioncontroldetails-object","title":"versionControlDetails object","text":"<p>A <code>versionControlDetails</code> object specifies the information necessary to retrieve from a version control system (VCS) the correct revision of the files that were scanned during the run.</p> <p></p>"},{"location":"reference/versionControlDetails/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"AndroidStudio\",\n                    \"semanticVersion\": \"1.0.0-beta.1\",\n                    \"informationUri\": \"https://android-studion.dev\"\n                }\n            },\n            \"versionControlProvenance\": [\n                {\n                    \"repositoryUri\": \"https://github.com/example-corp/package\",\n                    \"revisionId\": \"b87c4e9\",\n                    \"mappedTo\": {\n                        \"uriBaseId\": \"PACKAGE_ROOT\"\n                    }\n                },\n                {\n                    \"repositoryUri\": \"https://github.com/example-corp/plugin1\",\n                    \"revisionId\": \"cafdac7\",\n                    \"mappedTo\": {\n                        \"uri\": \"plugin1\",\n                        \"uriBaseId\": \"PACKAGE_ROOT\"\n                    }\n                },\n                {\n                    \"repositoryUri\": \"https://github.com/example-corp/plugin2\",\n                    \"revisionId\": \"d0dc2c0\",\n                    \"mappedTo\": {\n                        \"uri\": \"plugin2\",\n                        \"uriBaseId\": \"PACKAGE_ROOT\"\n                    }\n                }\n            ],\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/versionControlDetails/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/versionControlDetails.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/versionControlDetails.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Run;\nuse Bartlett\\Sarif\\Definition\\Tool;\nuse Bartlett\\Sarif\\Definition\\VersionControlDetails;\n\n$tool = new Tool($driver);\n\n$package = new VersionControlDetails('https://github.com/example-corp/package');\n$package-&gt;setRevisionId('b87c4e9');\n$packageMappedTo = new ArtifactLocation();\n$packageMappedTo-&gt;setUriBaseId('PACKAGE_ROOT');\n$package-&gt;setMappedTo($packageMappedTo);\n\n$plugin1 = new VersionControlDetails('https://github.com/example-corp/plugin1');\n$plugin1-&gt;setRevisionId('cafdac7');\n$plugin1MappedTo = new ArtifactLocation();\n$plugin1MappedTo-&gt;setUriBaseId('PACKAGE_ROOT');\n$plugin1MappedTo-&gt;setUri('plugin1');\n$plugin1-&gt;setMappedTo($plugin1MappedTo);\n\n$plugin2 = new VersionControlDetails('https://github.com/example-corp/plugin2');\n$plugin2-&gt;setRevisionId('d0dc2c0');\n$plugin2MappedTo = new ArtifactLocation();\n$plugin2MappedTo-&gt;setUriBaseId('PACKAGE_ROOT');\n$plugin2MappedTo-&gt;setUri('plugin2');\n$plugin2-&gt;setMappedTo($plugin2MappedTo);\n\n$run = new Run($tool);\n$run-&gt;addVersionControlDetails([$package, $plugin1, $plugin2]);\n</code></pre>"},{"location":"reference/webRequest/","title":"webRequest","text":""},{"location":"reference/webRequest/#webrequest-object","title":"webRequest object","text":"<p>A <code>webRequest</code> object describes an HTTP request (RFC7230).</p> <p></p>"},{"location":"reference/webRequest/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"webRequests\": [\n                {\n                    \"protocol\": \"http\",\n                    \"version\": \"1.1\",\n                    \"target\": \"httpbin.org/bearer\",\n                    \"method\": \"GET\",\n                    \"headers\": {\n                        \"accept\": \"application/json\",\n                        \"Authorization\": \"none\"\n                    }\n                }\n            ],\n            \"webResponses\": [\n                {\n                    \"protocol\": \"http\",\n                    \"version\": \"1.1\",\n                    \"statusCode\": 401,\n                    \"reasonPhrase\": \"Error: UNAUTHORIZED\",\n                    \"headers\": {\n                        \"access-control-allow-credentials\": \"true\",\n                        \"access-control-allow-origin\": \"*\",\n                        \"connection\": \"keep-alive\",\n                        \"content-length\": \"0\",\n                        \"content-type\": \"text/html; charset=utf-8\",\n                        \"date\": \"Sun, 07 Nov 2021 08:59:53 GMT\",\n                        \"server\": \"gunicorn/19.9.0\",\n                        \"www-authenticate\": \"Bearer\"\n                    }\n                }\n            ],\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/webRequest/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/webRequest.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/webRequest.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Run;\nuse Bartlett\\Sarif\\Definition\\Tool;\nuse Bartlett\\Sarif\\Definition\\WebRequest;\n\n$tool = new Tool($driver);\n\n$webRequest = new WebRequest();\n$webRequest-&gt;setProtocol('http');\n$webRequest-&gt;setVersion('1.1');\n$webRequest-&gt;setMethod('GET');\n$webRequest-&gt;setTarget('httpbin.org/bearer');\n$webRequest-&gt;addAdditionalPropertiesHeaders([\n    'accept' =&gt; 'application/json',\n    'Authorization' =&gt; 'none',\n]);\n\n$run = new Run($tool);\n$run-&gt;addWebRequests([$webRequest]);\n</code></pre>"},{"location":"reference/webResponse/","title":"webResponse","text":""},{"location":"reference/webResponse/#webresponse-object","title":"webResponse object","text":"<p>A <code>webResponse</code> object describes the response to an HTTP request (RFC7230)</p> <p></p>"},{"location":"reference/webResponse/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"webRequests\": [\n                {\n                    \"protocol\": \"http\",\n                    \"version\": \"1.1\",\n                    \"target\": \"httpbin.org/bearer\",\n                    \"method\": \"GET\",\n                    \"headers\": {\n                        \"accept\": \"application/json\",\n                        \"Authorization\": \"none\"\n                    }\n                }\n            ],\n            \"webResponses\": [\n                {\n                    \"protocol\": \"http\",\n                    \"version\": \"1.1\",\n                    \"statusCode\": 401,\n                    \"reasonPhrase\": \"Error: UNAUTHORIZED\",\n                    \"headers\": {\n                        \"access-control-allow-credentials\": \"true\",\n                        \"access-control-allow-origin\": \"*\",\n                        \"connection\": \"keep-alive\",\n                        \"content-length\": \"0\",\n                        \"content-type\": \"text/html; charset=utf-8\",\n                        \"date\": \"Sun, 07 Nov 2021 08:59:53 GMT\",\n                        \"server\": \"gunicorn/19.9.0\",\n                        \"www-authenticate\": \"Bearer\"\n                    }\n                }\n            ],\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/webResponse/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/webRequest.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/webRequest.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Run;\nuse Bartlett\\Sarif\\Definition\\Tool;\nuse Bartlett\\Sarif\\Definition\\WebResponse;\n\n$tool = new Tool($driver);\n\n$webResponse = new WebResponse();\n$webResponse-&gt;setProtocol('http');\n$webResponse-&gt;setVersion('1.1');\n$webResponse-&gt;setStatusCode(401);\n$webResponse-&gt;setReasonPhrase('Error: UNAUTHORIZED');\n$webResponse-&gt;addAdditionalProperties([\n    'access-control-allow-credentials' =&gt; 'true',\n    'access-control-allow-origin' =&gt; '*',\n    'connection' =&gt; 'keep-alive',\n    'content-length' =&gt; '0',\n    'content-type' =&gt; 'text/html; charset=utf-8',\n    'date' =&gt; 'Sun, 07 Nov 2021 08:59:53 GMT',\n    'server' =&gt; 'gunicorn/19.9.0',\n    'www-authenticate' =&gt; 'Bearer',\n]);\n\n$run = new Run($tool);\n$run-&gt;addWebResponses([$webResponse]);\n</code></pre>"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":""},{"location":"#about","title":"About","text":"<p>This PHP SDK produces the SARIF output, which is a JSON file formatted in accordance with the latest specification. This implementation follows the general format rules but also specifies several custom properties written in property bags.</p> <p></p>"},{"location":"#installation","title":"Installation","text":"<p>Learn how to install this library in different way.</p> <p>See Installation Guide</p>"},{"location":"#api-reference","title":"API Reference","text":"<p>Discover all API objects with each one at least an example of how to generate a SARIF report.</p> <p>See Reference Guide</p>"},{"location":"#api-builders","title":"API Builders","text":"<p>Discover all fluent builders with each one at least an example of how to generate a SARIF report.</p> <p>See Builder Guide</p>"},{"location":"installation/","title":"Installation","text":""},{"location":"installation/#installation","title":"Installation","text":"<ol> <li>Requirements</li> <li>PHAR</li> <li>Phive</li> <li>Composer</li> <li>Git</li> </ol>"},{"location":"installation/#requirements","title":"Requirements","text":"<ul> <li>PHP 7.4 or greater</li> <li>ext-json</li> <li>ext-pcre</li> <li>ext-spl</li> </ul>"},{"location":"installation/#phar","title":"PHAR","text":"<p>The preferred method of installation is to use the PHAR version which can be downloaded from the most recent Github Release. This method ensures you will not have any dependency conflict issue.</p> <p>[!TIP] When you want to use, load autoloader as follows :</p> <pre><code>require_once 'phar://' . '/absolute/path/to' . '/sarif-php-sdk.phar/vendor/autoload.php';\n</code></pre>"},{"location":"installation/#phive","title":"Phive","text":"<p>You can install application globally with Phive</p> <pre><code>phive install llaville/sarif-php-sdk --force-accept-unsigned\n</code></pre> <p>To upgrade global installation of the application use the following command:</p> <pre><code>phive update llaville/sarif-php-sdk --force-accept-unsigned\n</code></pre> <p>You can also install application locally to your project with Phive and configuration file <code>.phive/phars.xml</code></p> <pre><code>&lt;?xml version=\"1.0\" encoding=\"UTF-8\"?&gt;\n&lt;phive xmlns=\"https://phar.io/phive\"&gt;\n    &lt;phar name=\"llaville/sarif-php-sdk\" version=\"^1.3\" copy=\"false\" /&gt;\n&lt;/phive&gt;\n</code></pre> <pre><code>phive install --force-accept-unsigned\n</code></pre>"},{"location":"installation/#composer","title":"Composer","text":"<p>The recommended way to install this library is through composer. If you don't know yet what is composer, have a look on introduction.</p> <pre><code>composer require bartlett/sarif-php-sdk ^1.3\n</code></pre> <p>If you cannot install it because of a dependency conflict, or you prefer to install it for your project, we recommend you to take a look at bamarni/composer-bin-plugin. Example:</p> <pre><code>composer require --dev bamarni/composer-bin-plugin\ncomposer bin sarif-php-sdk require --dev bartlett/sarif-php-sdk\n</code></pre>"},{"location":"installation/#git","title":"Git","text":"<p>The SARIF PHP SDK can be directly used from GitHub by cloning the repository into a directory of your choice.</p> <pre><code>git clone -b 1.3 https://github.com/llaville/sarif-php-sdk.git\n</code></pre>"},{"location":"builder/","title":"Index","text":""},{"location":"builder/#builders","title":"Builders","text":"<p>When SARIF PHP SDK is used to generate reports the standard API reclaims to declare each object and know how to link them. It can often be tedious to manually construct objects.</p> <p>Since release 1.5.0, the project provides a number of utilities to simplify the construction of sarif objects with their properties.</p> <p></p>"},{"location":"builder/#fluent-builders","title":"Fluent builders","text":"<p>The library comes with a number of builders, which allow creating sarif objects using a fluent interface. Builders are created using the <code>Bartlett\\Sarif\\Factory\\BuilderFactory</code> and the final constructed object is accessed through <code>build()</code>.</p> <p>Here is an example:</p> <pre><code>&lt;?php\nuse Bartlett\\Sarif\\Factory\\BuilderFactory;\n\n$factory = new BuilderFactory();\n\n$spec = $factory-&gt;specification('2.1.0')\n    -&gt;addRun(\n        $factory-&gt;run()\n            -&gt;tool(\n                $factory-&gt;tool()\n                    -&gt;driver(\n                        $factory-&gt;driver()\n                            -&gt;name('Psalm')\n                            -&gt;version('4.x-dev')\n                            -&gt;informationUri('https://psalm.de')\n                    )\n            )\n            -&gt;setProperties([\n                'stableId' =&gt; 'Nightly static analysis run',\n            ])\n    )\n;\n\n$sarifLogObject = $spec-&gt;build();\n</code></pre>"},{"location":"reference/","title":"API Reference","text":""},{"location":"reference/#address-object","title":"address object","text":"<p>See official specification</p>"},{"location":"reference/#artifact-object","title":"artifact object","text":"<p>See official specification</p>"},{"location":"reference/#artifactchange-object","title":"artifactChange object","text":"<p>See official specification</p>"},{"location":"reference/#artifactcontent-object","title":"artifactContent object","text":"<p>See official specification</p>"},{"location":"reference/#attachment-object","title":"attachment object","text":"<p>See official specification</p>"},{"location":"reference/#codeflow-object","title":"codeFlow object","text":"<p>See official specification</p>"},{"location":"reference/#configurationoverride-object","title":"configurationOverride object","text":"<p>See official specification</p>"},{"location":"reference/#conversion-object","title":"conversion object","text":"<p>See official specification</p>"},{"location":"reference/#edge-object","title":"edge object","text":"<p>See official specification</p>"},{"location":"reference/#edgetraversal-object","title":"edgeTraversal object","text":"<p>See official specification</p>"},{"location":"reference/#exception-object","title":"exception object","text":"<p>See official specification</p>"},{"location":"reference/#externalproperties-object","title":"externalProperties object","text":"<p>See official specification</p>"},{"location":"reference/#externalpropertyfilereference-object","title":"externalPropertyFileReference object","text":"<p>See official specification</p>"},{"location":"reference/#externalpropertyfilereferences-object","title":"externalPropertyFileReferences object","text":"<p>See official specification</p>"},{"location":"reference/#fix-object","title":"fix object","text":"<p>See official specification</p>"},{"location":"reference/#graph-object","title":"graph object","text":"<p>See official specification</p>"},{"location":"reference/#graphtraversal-object","title":"graphTraversal object","text":"<p>See official specification</p>"},{"location":"reference/#invocation-object","title":"invocation object","text":"<p>See official specification</p>"},{"location":"reference/#locationrelationship-object","title":"locationRelationship object","text":"<p>See official specification</p>"},{"location":"reference/#logicallocation-object","title":"logicalLocation object","text":"<p>See official specification</p>"},{"location":"reference/#message-object","title":"message object","text":"<p>See official specification</p>"},{"location":"reference/#node-object","title":"node object","text":"<p>See official specification</p>"},{"location":"reference/#notification-object","title":"notification object","text":"<p>See official specification</p>"},{"location":"reference/#physicallocation-object","title":"physicalLocation object","text":"<p>See official specification</p>"},{"location":"reference/#rectangle-object","title":"rectangle object","text":"<p>See official specification</p>"},{"location":"reference/#replacement-object","title":"replacement object","text":"<p>See official specification</p>"},{"location":"reference/#reportingconfiguration-object","title":"reportingConfiguration object","text":"<p>See official specification</p>"},{"location":"reference/#reportingdescriptor-object","title":"reportingDescriptor object","text":"<p>See official specification</p>"},{"location":"reference/#reportingdescriptorreference-object","title":"reportingDescriptorReference object","text":"<p>See official specification</p>"},{"location":"reference/#reportingdescriptorrelationship-object","title":"reportingDescriptorRelationship object","text":"<p>See official specification</p>"},{"location":"reference/#result-object","title":"result object","text":"<p>See official specification</p>"},{"location":"reference/#resultprovenance-object","title":"resultProvenance object","text":"<p>See official specification</p>"},{"location":"reference/#run-object","title":"run object","text":"<p>See official specification</p>"},{"location":"reference/#runautomationdetails-object","title":"runAutomationDetails object","text":"<p>See official specification</p>"},{"location":"reference/#sariflog-object","title":"sarifLog object","text":"<p>See official specification</p>"},{"location":"reference/#speciallocations-object","title":"specialLocations object","text":"<p>See official specification</p>"},{"location":"reference/#stack-object","title":"stack object","text":"<p>See official specification</p>"},{"location":"reference/#stackframe-object","title":"stackFrame object","text":"<p>See official specification</p>"},{"location":"reference/#suppression-object","title":"suppression object","text":"<p>See official specification</p>"},{"location":"reference/#threadflow-object","title":"threadFlow object","text":"<p>See official specification</p>"},{"location":"reference/#threadflowlocation-object","title":"threadFlowLocation object","text":"<p>See official specification</p>"},{"location":"reference/#tool-object","title":"tool object","text":"<p>See official specification</p>"},{"location":"reference/#toolcomponentreference-object","title":"toolComponentReference object","text":"<p>See official specification</p>"},{"location":"reference/#translationmetadata-object","title":"translationMetadata object","text":"<p>See official specification</p>"},{"location":"reference/#versioncontroldetails-object","title":"versionControlDetails object","text":"<p>See official specification</p>"},{"location":"reference/#webrequest-object","title":"webRequest object","text":"<p>See official specification</p>"},{"location":"reference/#webresponse-object","title":"webResponse object","text":"<p>See official specification</p>"},{"location":"reference/address/","title":"Address","text":""},{"location":"reference/address/#address-object","title":"address object","text":"<p>An <code>address</code> object describes a physical or virtual address, or a range of addresses, in an \u201caddressable region\u201d (memory or a binary file).</p> <p></p>"},{"location":"reference/address/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"addresses\": [\n                {\n                    \"absoluteAddress\": 1024,\n                    \"kind\": \"module\",\n                    \"name\": \"Multitool.exe\"\n                },\n                {\n                    \"absoluteAddress\": 1400,\n                    \"relativeAddress\": 376,\n                    \"kind\": \"header\",\n                    \"name\": \"Sections\",\n                    \"offsetFromParent\": 376,\n                    \"parentIndex\": 0\n                },\n                {\n                    \"absoluteAddress\": 1536,\n                    \"relativeAddress\": 512,\n                    \"kind\": \"section\",\n                    \"name\": \".text\",\n                    \"offsetFromParent\": 136,\n                    \"parentIndex\": 1\n                }\n            ],\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/address/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/address.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/address.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Address;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$address1 = new Address();\n$address1-&gt;setName('Multitool.exe');\n$address1-&gt;setKind('module');\n$address1-&gt;setAbsoluteAddress(1024);\n\n$address2 = new Address();\n$address2-&gt;setName('Sections');\n$address2-&gt;setKind('header');\n$address2-&gt;setParentIndex(0);\n$address2-&gt;setOffsetFromParent(376);\n$address2-&gt;setAbsoluteAddress(1400);\n$address2-&gt;setRelativeAddress(376);\n\n$address3 = new Address();\n$address3-&gt;setName('.text');\n$address3-&gt;setKind('section');\n$address3-&gt;setParentIndex(1);\n$address3-&gt;setOffsetFromParent(136);\n$address3-&gt;setAbsoluteAddress(1536);\n$address3-&gt;setRelativeAddress(512);\n\n$run = new Run($tool);\n$run-&gt;addAddresses([$address1, $address2, $address3]);\n</code></pre>"},{"location":"reference/artifact/","title":"Artifact","text":""},{"location":"reference/artifact/#artifact-object","title":"artifact object","text":"<p>An <code>artifact</code> object represents a single artifact.</p> <p></p>"},{"location":"reference/artifact/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"artifacts\": [\n                {\n                    \"location\": {\n                        \"uri\": \"file:///C:/Code/app.zip\"\n                    },\n                    \"mimeType\": \"application/zip\"\n                },\n                {\n                    \"location\": {\n                        \"uri\": \"docs/intro.docx\"\n                    },\n                    \"mimeType\": \"application/vnd.openxmlformats-officedocument.wordprocessingml.document\"\n                },\n                {\n                    \"parentIndex\": 1,\n                    \"offset\": 17522,\n                    \"length\": 4050,\n                    \"mimeType\": \"application/x-contoso-animation\"\n                }\n            ],\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/artifact/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/artifact.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/artifact.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Artifact;\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$artifact1 = new Artifact();\n$artifactLocation1 = new ArtifactLocation();\n$artifactLocation1-&gt;setUri('file:///C:/Code/app.zip');\n$artifact1-&gt;setLocation($artifactLocation1);\n$artifact1-&gt;setMimeType('application/zip');\n\n$artifact2 = new Artifact();\n$artifactLocation2 = new ArtifactLocation();\n$artifactLocation2-&gt;setUri('docs/intro.docx');\n$artifact2-&gt;setLocation($artifactLocation2);\n$artifact2-&gt;setMimeType('application/vnd.openxmlformats-officedocument.wordprocessingml.document');\n$artifact2-&gt;setParentIndex(0);\n\n$artifact3 = new Artifact();\n$artifact3-&gt;setOffset(17522);\n$artifact3-&gt;setLength(4050);\n$artifact3-&gt;setMimeType('application/x-contoso-animation');\n$artifact3-&gt;setParentIndex(1);\n\n$run = new Run($tool);\n$run-&gt;addArtifacts([$artifact1, $artifact2, $artifact3]);\n</code></pre>"},{"location":"reference/artifactChange/","title":"artifactChange","text":""},{"location":"reference/artifactChange/#artifactchange-object","title":"artifactChange object","text":"<p>An <code>artifactChange</code> object represents a change to a single artifact.</p> <p></p>"},{"location":"reference/artifactChange/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CA1001\",\n                    \"fixes\": [\n                        {\n                            \"artifactChanges\": [\n                                {\n                                    \"artifactLocation\": {\n                                        \"uri\": \"src/a.c\"\n                                    },\n                                    \"replacements\": [\n                                        {\n                                            \"deletedRegion\": {\n                                                \"startLine\": 1,\n                                                \"startColumn\": 1,\n                                                \"endLine\": 1\n                                            },\n                                            \"insertedContent\": {\n                                                \"text\": \"// \"\n                                            }\n                                        }\n                                    ]\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/artifactChange/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/fix.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/fix.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactChange;\nuse Bartlett\\Sarif\\Definition\\ArtifactContent;\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Replacement;\n\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('src/a.c');\n$replacement = new Replacement(new Region(1, 1, 1));\n$insertedContent = new ArtifactContent();\n$insertedContent-&gt;setText('// ');\n$replacement-&gt;setInsertedContent($insertedContent);\n$artifactChange = new ArtifactChange($artifactLocation, [$replacement]);\n</code></pre>"},{"location":"reference/artifactContent/","title":"artifactContent","text":""},{"location":"reference/artifactContent/#artifactcontent-object","title":"artifactContent object","text":"<p>Certain properties in this document represent the contents of portions of artifacts external to the log file, for example, artifacts that were scanned by an analysis tool. SARIF represents such content with an <code>artifactContent</code> object. Depending on the circumstances, the SARIF log file might need to represent this content as readable text, raw bytes, or both.</p> <p></p>"},{"location":"reference/artifactContent/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CA1001\",\n                    \"fixes\": [\n                        {\n                            \"artifactChanges\": [\n                                {\n                                    \"artifactLocation\": {\n                                        \"uri\": \"src/a.c\"\n                                    },\n                                    \"replacements\": [\n                                        {\n                                            \"deletedRegion\": {\n                                                \"startLine\": 1,\n                                                \"startColumn\": 1,\n                                                \"endLine\": 1\n                                            },\n                                            \"insertedContent\": {\n                                                \"text\": \"// \"\n                                            }\n                                        }\n                                    ]\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/artifactContent/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/fix.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/fix.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactChange;\nuse Bartlett\\Sarif\\Definition\\ArtifactContent;\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Replacement;\n\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('src/a.c');\n$replacement = new Replacement(new Region(1, 1, 1));\n$insertedContent = new ArtifactContent();\n$insertedContent-&gt;setText('// ');\n$replacement-&gt;setInsertedContent($insertedContent);\n$artifactChange = new ArtifactChange($artifactLocation, [$replacement]);\n</code></pre>"},{"location":"reference/attachment/","title":"Attachment","text":""},{"location":"reference/attachment/#attachment-object","title":"attachment object","text":"<p>An <code>attachment</code> object describes an artifact relevant to the detection of a result.</p> <p></p>"},{"location":"reference/attachment/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"fullName\": \"CodeScanner 1.1, Developer Preview (en-US)\",\n                    \"version\": \"1.1.2b12\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Have a look on screen shot provided\"\n                    },\n                    \"attachments\": [\n                        {\n                            \"artifactLocation\": {\n                                \"uri\": \"file:///C:/ScanOutput/image001.png\"\n                            },\n                            \"description\": {\n                                \"text\": \"Screen shot\"\n                            }\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/attachment/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/attachment.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/attachment.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Attachment;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$attachment = new Attachment();\n$attachment-&gt;setDescription(new Message('Screen shot'));\n$attachment-&gt;setArtifactLocation(new ArtifactLocation('file:///C:/ScanOutput/image001.png'));\n\n$result = new Result(new Message('Have a look on screen shot provided'));\n$result-&gt;addAttachments([$attachment]);\n</code></pre>"},{"location":"reference/codeFlow/","title":"codeFlow","text":""},{"location":"reference/codeFlow/#codeflow-object","title":"codeFlow object","text":"<p>A <code>codeFlow</code> object describes the progress of one or more programs through one or more thread flows, which together lead to the detection of a problem in the system being analyzed.</p> <p></p>"},{"location":"reference/codeFlow/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"A result object\"\n                    },\n                    \"codeFlows\": [\n                        {\n                            \"threadFlows\": [\n                                {\n                                    \"locations\": [\n                                        {\n                                            \"location\": {\n                                                \"physicalLocation\": {\n                                                    \"artifactLocation\": {\n                                                        \"uri\": \"ui/window.c\",\n                                                        \"uriBaseId\": \"SRCROOT\"\n                                                    },\n                                                    \"region\": {\n                                                        \"startLine\": 42\n                                                    }\n                                                }\n                                            },\n                                            \"state\": {\n                                                \"x\": {\n                                                    \"text\": \"42\"\n                                                },\n                                                \"y\": {\n                                                    \"text\": \"54\"\n                                                },\n                                                \"x+y\": {\n                                                    \"text\": \"96\"\n                                                }\n                                            },\n                                            \"nestingLevel\": 0,\n                                            \"executionOrder\": 2\n                                        }\n                                    ],\n                                    \"id\": \"thread-123\",\n                                    \"message\": {\n                                        \"text\": \"A threadFlow object\"\n                                    }\n                                }\n                            ],\n                            \"message\": {\n                                \"text\": \"A codeFlow object\"\n                            }\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/codeFlow/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/codeFlow.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/codeFlow.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\CodeFlow;\nuse Bartlett\\Sarif\\Definition\\Location;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\PhysicalLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Result;\nuse Bartlett\\Sarif\\Definition\\ThreadFlow;\nuse Bartlett\\Sarif\\Definition\\ThreadFlowLocation;\n\n$threadFlowLocation = new ThreadFlowLocation();\n$location = new Location();\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('ui/window.c');\n$artifactLocation-&gt;setUriBaseId('SRCROOT');\n$physicalLocation = new PhysicalLocation($artifactLocation);\n$physicalLocation-&gt;setRegion(new Region(42));\n$location-&gt;setPhysicalLocation($physicalLocation);\n$threadFlowLocation-&gt;setLocation($location);\n$threadFlowLocation-&gt;addAdditionalProperties([\n    'x' =&gt; new MultiformatMessageString('42'),\n    'y' =&gt; new MultiformatMessageString('54'),\n    'x+y' =&gt; new MultiformatMessageString('96'),\n]);\n$threadFlowLocation-&gt;setNestingLevel(0);\n$threadFlowLocation-&gt;setExecutionOrder(2);\n\n$threadFlow = new ThreadFlow([$threadFlowLocation]);\n$threadFlow-&gt;setId('thread-123');\n$threadFlow-&gt;setMessage(new Message('A threadFlow object'));\n\n$codeFlow = new CodeFlow([$threadFlow]);\n$codeFlow-&gt;setMessage(new Message('A codeFlow object'));\n\n$result = new Result(new Message('A result object'));\n$result-&gt;addCodeFlows([$codeFlow]);\n</code></pre>"},{"location":"reference/configurationOverride/","title":"configurationOverride","text":""},{"location":"reference/configurationOverride/#configurationoverride-object","title":"configurationOverride object","text":"<p>A <code>configurationOverride</code> object modifies the effective runtime configuration of a specified <code>reportingDescriptor</code> object, which we refer to as theDescriptor.</p> <p></p>"},{"location":"reference/configurationOverride/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CA2101\",\n                            \"defaultConfiguration\": {\n                                \"enabled\": true,\n                                \"level\": \"error\",\n                                \"rank\": -1\n                            }\n                        }\n                    ]\n                }\n            },\n            \"invocations\": [\n                {\n                    \"executionSuccessful\": true,\n                    \"ruleConfigurationOverrides\": [\n                        {\n                            \"configuration\": {\n                                \"enabled\": true,\n                                \"level\": \"warning\",\n                                \"rank\": -1\n                            },\n                            \"descriptor\": {\n                                \"index\": 0\n                            }\n                        }\n                    ]\n                }\n            ],\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/configurationOverride/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/configurationOverride.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/configurationOverride.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ConfigurationOverride;\nuse Bartlett\\Sarif\\Definition\\Invocation;\nuse Bartlett\\Sarif\\Definition\\ReportingConfiguration;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptor;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptorReference;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$rule = new ReportingDescriptor('CA2101');\n$reportingConf = new ReportingConfiguration();\n$reportingConf-&gt;setLevel('error');\n$rule-&gt;setDefaultConfiguration($reportingConf);\n$driver-&gt;addRules([$rule]);\n\n$ruleConf = new ReportingConfiguration();\n$ruleConf-&gt;setLevel('warning');\n\n$confOverrides = new ConfigurationOverride();\n$descriptor = new ReportingDescriptorReference(0);\n$confOverrides-&gt;setDescriptor($descriptor);\n$confOverrides-&gt;setConfiguration($ruleConf);\n\n$invocation = new Invocation(true);\n$invocation-&gt;addRuleConfigurationOverrides([$confOverrides]);\n\n$run = new Run($tool);\n$run-&gt;addInvocations([$invocation]);\n</code></pre>"},{"location":"reference/conversion/","title":"Conversion","text":""},{"location":"reference/conversion/#conversion-object","title":"conversion object","text":"<p>A <code>conversion</code> object describes how a converter transformed the output of an analysis tool from the analysis tool\u2019s native output format into the SARIF format.</p> <p></p>"},{"location":"reference/conversion/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"AndroidStudio\",\n                    \"semanticVersion\": \"1.0.0-beta.1\",\n                    \"informationUri\": \"https://android-studion.dev\"\n                }\n            },\n            \"conversion\": {\n                \"tool\": {\n                    \"driver\": {\n                        \"name\": \"SARIF SDK Multitool\"\n                    }\n                },\n                \"invocation\": {\n                    \"executionSuccessful\": true,\n                    \"commandLine\": \"Sarif.Multitool.exe convert -t AndroidStudio northwind.log\"\n                },\n                \"analysisToolLogFiles\": [\n                    {\n                        \"uri\": \"northwind.log\",\n                        \"uriBaseId\": \"$LOG_DIR$\"\n                    }\n                ]\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/conversion/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/conversion.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/conversion.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Conversion;\nuse Bartlett\\Sarif\\Definition\\Invocation;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('northwind.log');\n$artifactLocation-&gt;setUriBaseId('$LOG_DIR$');\n\n$invocation = new Invocation(true);\n$invocation-&gt;setCommandLine('Sarif.Multitool.exe convert -t AndroidStudio northwind.log');\n\n$conversion = new Conversion($converter);\n$conversion-&gt;addAnalysisToolLogFiles([$artifactLocation]);\n$conversion-&gt;setInvocation($invocation);\n\n$run = new Run($tool);\n$run-&gt;setConversion($conversion);\n</code></pre>"},{"location":"reference/edge/","title":"Edge","text":""},{"location":"reference/edge/#edge-object","title":"edge object","text":"<p>A <code>edge</code> object represents a directed edge in the graph represented by theGraph.</p> <p></p>"},{"location":"reference/edge/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"fullName\": \"CodeScanner 1.1, Developer Preview (en-US)\",\n                    \"version\": \"1.1.2b12\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Have a look on this graph\"\n                    },\n                    \"graphs\": [\n                        {\n                            \"nodes\": [\n                                {\n                                    \"id\": \"n2\"\n                                },\n                                {\n                                    \"id\": \"n3\"\n                                },\n                                {\n                                    \"id\": \"n4\"\n                                },\n                                {\n                                    \"id\": \"n1\",\n                                    \"children\": [\n                                        {\n                                            \"id\": \"n3\"\n                                        }\n                                    ]\n                                }\n                            ],\n                            \"edges\": [\n                                {\n                                    \"id\": \"e1\",\n                                    \"sourceNodeId\": \"n3\",\n                                    \"targetNodeId\": \"n4\"\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/edge/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/graph.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/graph.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Attachment;\nuse Bartlett\\Sarif\\Definition\\Edge;\nuse Bartlett\\Sarif\\Definition\\Graph;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Node;\nuse Bartlett\\Sarif\\Definition\\Rectangle;\nuse Bartlett\\Sarif\\Definition\\Result;\nuse Bartlett\\Sarif\\Definition\\Run;\nuse Bartlett\\Sarif\\Definition\\Tool;\nuse Bartlett\\Sarif\\Definition\\ToolComponent;\nuse Bartlett\\Sarif\\SarifLog;\n\n$nodes = [];\n$nodes[2] = new Node('n2');\n$nodes[3] = new Node('n3');\n$nodes[4] = new Node('n4');\n$nodes[1] = new Node('n1');\n$nodes[1]-&gt;addChildren([$nodes[3]]);\n\n$edges = [];\n$edges[1] = new Edge('e1', 'n3', 'n4');\n\n$graph = new Graph();\n$graph-&gt;addNodes($nodes);\n$graph-&gt;addEdges($edges);\n\n$result = new Result(new Message('Have a look on this graph'));\n$result-&gt;addGraphs([$graph]);\n</code></pre>"},{"location":"reference/edgeTraversal/","title":"edgeTraversal","text":""},{"location":"reference/edgeTraversal/#edgetraversal-object","title":"edgeTraversal object","text":"<p>An <code>edgeTraversal</code> object represents the traversal of a single edge during a graph traversal.</p> <p></p>"},{"location":"reference/edgeTraversal/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"A graph and edge traversal objects\"\n                    },\n                    \"graphs\": [\n                        {\n                            \"nodes\": [\n                                {\n                                    \"id\": \"n1\"\n                                },\n                                {\n                                    \"id\": \"n2\"\n                                },\n                                {\n                                    \"id\": \"n3\"\n                                },\n                                {\n                                    \"id\": \"n4\"\n                                }\n                            ],\n                            \"edges\": [\n                                {\n                                    \"id\": \"e1\",\n                                    \"sourceNodeId\": \"n1\",\n                                    \"targetNodeId\": \"n2\"\n                                },\n                                {\n                                    \"id\": \"e2\",\n                                    \"sourceNodeId\": \"n2\",\n                                    \"targetNodeId\": \"n3\"\n                                },\n                                {\n                                    \"id\": \"e3\",\n                                    \"sourceNodeId\": \"n2\",\n                                    \"targetNodeId\": \"n4\"\n                                }\n                            ]\n                        }\n                    ],\n                    \"graphTraversals\": [\n                        {\n                            \"resultGraphIndex\": 0,\n                            \"initialState\": {\n                                \"x\": {\n                                    \"text\": \"1\"\n                                },\n                                \"y\": {\n                                    \"text\": \"2\"\n                                },\n                                \"x+y\": {\n                                    \"text\": \"3\"\n                                }\n                            },\n                            \"edgeTraversals\": [\n                                {\n                                    \"edgeId\": \"e1\",\n                                    \"finalState\": {\n                                        \"x\": {\n                                            \"text\": \"4\"\n                                        },\n                                        \"y\": {\n                                            \"text\": \"2\"\n                                        },\n                                        \"x+y\": {\n                                            \"text\": \"6\"\n                                        }\n                                    }\n                                },\n                                {\n                                    \"edgeId\": \"e3\",\n                                    \"finalState\": {\n                                        \"x\": {\n                                            \"text\": \"4\"\n                                        },\n                                        \"y\": {\n                                            \"text\": \"7\"\n                                        },\n                                        \"x+y\": {\n                                            \"text\": \"11\"\n                                        }\n                                    }\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/edgeTraversal/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/graphTraversal.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/graphTraversal.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Edge;\nuse Bartlett\\Sarif\\Definition\\EdgeTraversal;\nuse Bartlett\\Sarif\\Definition\\Graph;\nuse Bartlett\\Sarif\\Definition\\GraphTraversal;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\Node;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$nodes = [];\n$nodes[1] = new Node('n1');\n$nodes[2] = new Node('n2');\n$nodes[3] = new Node('n3');\n$nodes[4] = new Node('n4');\n\n$edges = [];\n$edges[1] = new Edge('e1', 'n1', 'n2');\n$edges[2] = new Edge('e2', 'n2', 'n3');\n$edges[3] = new Edge('e3', 'n2', 'n4');\n\n$graph = new Graph();\n$graph-&gt;addNodes($nodes);\n$graph-&gt;addEdges($edges);\n\n$graphTraversal = new GraphTraversal(null, 0);\n$graphTraversal-&gt;addAdditionalPropertiesInitialState([\n    'x' =&gt; new MultiformatMessageString('1'),\n    'y' =&gt; new MultiformatMessageString('2'),\n    'x+y' =&gt; new MultiformatMessageString('3'),\n]);\n\n$edgeTraversal1 = new EdgeTraversal('e1');\n$edgeTraversal1-&gt;addAdditionalProperties([\n    'x' =&gt; new MultiformatMessageString('4'),\n    'y' =&gt; new MultiformatMessageString('2'),\n    'x+y' =&gt; new MultiformatMessageString('6'),\n]);\n$edgeTraversal3 = new EdgeTraversal('e3');\n$edgeTraversal3-&gt;addAdditionalProperties([\n    'x' =&gt; new MultiformatMessageString('4'),\n    'y' =&gt; new MultiformatMessageString('7'),\n    'x+y' =&gt; new MultiformatMessageString('11'),\n]);\n$graphTraversal-&gt;addEdgeTraversals([$edgeTraversal1, $edgeTraversal3]);\n\n$result = new Result(new Message('A graph and edge traversal objects'));\n$result-&gt;addGraphs([$graph]);\n$result-&gt;addGraphTraversals([$graphTraversal]);\n</code></pre>"},{"location":"reference/exception/","title":"Exception","text":""},{"location":"reference/exception/#exception-object","title":"exception object","text":"<p>An <code>exception</code> object describes a runtime exception encountered during the execution of an analysis tool. This includes signals in POSIX-conforming operating systems.</p> <p></p>"},{"location":"reference/exception/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CTN9999\",\n                            \"shortDescription\": {\n                                \"text\": \"First version of rule.\"\n                            }\n                        },\n                        {\n                            \"id\": \"CTN9999\",\n                            \"shortDescription\": {\n                                \"text\": \"Second version of rule.\"\n                            }\n                        }\n                    ]\n                }\n            },\n            \"invocations\": [\n                {\n                    \"executionSuccessful\": true,\n                    \"toolExecutionNotifications\": [\n                        {\n                            \"message\": {\n                                \"text\": \"Exception evaluating rule 'C2001'. Rule configuration is missing.\"\n                            },\n                            \"level\": \"error\",\n                            \"exception\": {\n                                \"message\": \"Exception evaluating rule 'C2001'\"\n                            },\n                            \"descriptor\": {\n                                \"index\": 1,\n                                \"id\": \"CTN9999\"\n                            }\n                        }\n                    ]\n                }\n            ],\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CTN9999\"\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/exception/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/exception.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/exception.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Exception;\nuse Bartlett\\Sarif\\Definition\\Invocation;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\Notification;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptor;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptorReference;\nuse Bartlett\\Sarif\\Definition\\Result;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$notification = new Notification(new Message(\"Exception evaluating rule 'C2001'. Rule configuration is missing.\"));\n$notification-&gt;setAssociatedRule(new ReportingDescriptorReference(0, 'C2001'));\n$notification-&gt;setDescriptor(new ReportingDescriptorReference(1, 'CTN9999'));\n$notification-&gt;setLevel('error');\n$exception = new Exception();\n$exception-&gt;setMessage(\"Exception evaluating rule 'C2001'\");\n$notification-&gt;setRuntimeException($exception);\n$invocation = new Invocation(true);\n$invocation-&gt;addToolExecutionNotifications([$notification]);\n\n$result = new Result(new Message('...'));\n$result-&gt;setRuleId('CTN9999');\n\n$run = new Run($tool);\n$run-&gt;addResults([$result]);\n$run-&gt;addInvocations([$invocation]);\n</code></pre>"},{"location":"reference/externalProperties/","title":"externalProperties","text":""},{"location":"reference/externalProperties/#externalproperties-object","title":"externalProperties object","text":"<p>The top-level element of an external property file SHALL be an object which we refer to as an <code>externalProperties</code> object.</p> <p></p>"},{"location":"reference/externalProperties/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": []\n        }\n    ],\n    \"inlineExternalProperties\": [\n        {\n            \"schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n            \"version\": \"2.1.0\",\n            \"guid\": \"00001111-2222-1111-8888-555566667777\",\n            \"runGuid\": \"88889999-AAAA-1111-8888-DDDDEEEEFFFF\",\n            \"externalizedProperties\": {\n                \"team\": \"Security Assurance Team\"\n            },\n            \"artifacts\": [\n                {\n                    \"location\": {\n                        \"uri\": \"apple.png\"\n                    },\n                    \"mimeType\": \"image/png\"\n                },\n                {\n                    \"location\": {\n                        \"uri\": \"banana.png\"\n                    },\n                    \"mimeType\": \"image/png\"\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/externalProperties/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/externalProperties.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/externalProperties.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Artifact;\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\ExternalProperties;\nuse Bartlett\\Sarif\\Definition\\PropertyBag;\nuse Bartlett\\Sarif\\Definition\\Run;\nuse Bartlett\\Sarif\\SarifLog;\n\n$apple = new Artifact();\n$location = new ArtifactLocation();\n$location-&gt;setUri('apple.png');\n$apple-&gt;setLocation($location);\n$apple-&gt;setMimeType('image/png');\n\n$banana = new Artifact();\n$location = new ArtifactLocation();\n$location-&gt;setUri('banana.png');\n$banana-&gt;setLocation($location);\n$banana-&gt;setMimeType('image/png');\n\n$propertyBag = new PropertyBag();\n$propertyBag-&gt;addProperty('team', 'Security Assurance Team');\n\n$run = new Run($tool);\n\n$log = new SarifLog([$run]);\n$externalProperties = new ExternalProperties();\n$externalProperties-&gt;setGuid('00001111-2222-1111-8888-555566667777');\n$externalProperties-&gt;setRunGuid('88889999-AAAA-1111-8888-DDDDEEEEFFFF');\n$externalProperties-&gt;addArtifacts([$apple, $banana]);\n$externalProperties-&gt;setExternalizedProperties($propertyBag);\n$log-&gt;addInlineExternalProperties([$externalProperties]);\n</code></pre>"},{"location":"reference/externalPropertyFileReference/","title":"externalPropertyFileReference","text":""},{"location":"reference/externalPropertyFileReference/#externalpropertyfilereference-object","title":"externalPropertyFileReference object","text":"<p>An <code>externalPropertyFileReference</code> object contains information that enables a SARIF consumer to locate the external property files that contain the values of all externalized properties associated with theRun.</p> <p></p>"},{"location":"reference/externalPropertyFileReference/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"originalUriBaseIds\": {\n                \"LOGSDIR\": {\n                    \"uri\": \"file:///C:/logs/\"\n                }\n            },\n            \"externalPropertyFileReferences\": {\n                \"conversion\": {\n                    \"location\": {\n                        \"uri\": \"scantool.conversion.sarif-external-properties\",\n                        \"uriBaseId\": \"LOGSDIR\"\n                    },\n                    \"guid\": \"11111111-1111-1111-8888-111111111111\"\n                },\n                \"results\": [\n                    {\n                        \"location\": {\n                            \"uri\": \"scantool.results-1.sarif-external-properties\",\n                            \"uriBaseId\": \"LOGSDIR\"\n                        },\n                        \"guid\": \"22222222-2222-1111-8888-222222222222\",\n                        \"itemCount\": 1000\n                    },\n                    {\n                        \"location\": {\n                            \"uri\": \"scantool.results-2.sarif-external-properties\",\n                            \"uriBaseId\": \"LOGSDIR\"\n                        },\n                        \"guid\": \"33333333-3333-1111-8888-333333333333\",\n                        \"itemCount\": 4277\n                    }\n                ]\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/externalPropertyFileReference/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/externalPropertyFileReferences.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/externalPropertyFileReferences.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\ExternalPropertyFileReference;\nuse Bartlett\\Sarif\\Definition\\ExternalPropertyFileReferences;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$run = new Run($tool);\n$logsDir = new ArtifactLocation();\n$logsDir-&gt;setUri('file:///C:/logs/');\n$run-&gt;addAdditionalProperties([\n    'LOGSDIR' =&gt; $logsDir,\n]);\n\n$location = new ArtifactLocation();\n$location-&gt;setUri('scantool.conversion.sarif-external-properties');\n$location-&gt;setUriBaseId('LOGSDIR');\n$conversion = new ExternalPropertyFileReference($location, '11111111-1111-1111-8888-111111111111');\n\n$location = new ArtifactLocation();\n$location-&gt;setUri('scantool.results-1.sarif-external-properties');\n$location-&gt;setUriBaseId('LOGSDIR');\n$resultRef1 = new ExternalPropertyFileReference($location, '22222222-2222-1111-8888-222222222222');\n$resultRef1-&gt;setItemCount(1000);\n\n$location = new ArtifactLocation();\n$location-&gt;setUri('scantool.results-2.sarif-external-properties');\n$location-&gt;setUriBaseId('LOGSDIR');\n$resultRef2 = new ExternalPropertyFileReference($location, '33333333-3333-1111-8888-333333333333');\n$resultRef2-&gt;setItemCount(4277);\n\n$externalPropertyFileReferences = new ExternalPropertyFileReferences();\n$externalPropertyFileReferences-&gt;setConversion($conversion);\n$externalPropertyFileReferences-&gt;addResults([$resultRef1, $resultRef2]);\n$run-&gt;setExternalPropertyFileReferences($externalPropertyFileReferences);\n</code></pre>"},{"location":"reference/externalPropertyFileReferences/","title":"externalPropertyFileReferences","text":""},{"location":"reference/externalPropertyFileReferences/#externalpropertyfilereferences-object","title":"externalPropertyFileReferences object","text":"<p>An <code>externalPropertyFileReferences</code> object contains information that enables a SARIF consumer to locate the external property files that contain the values of all externalized properties associated with theRun.</p> <p></p>"},{"location":"reference/externalPropertyFileReferences/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"originalUriBaseIds\": {\n                \"LOGSDIR\": {\n                    \"uri\": \"file:///C:/logs/\"\n                }\n            },\n            \"externalPropertyFileReferences\": {\n                \"conversion\": {\n                    \"location\": {\n                        \"uri\": \"scantool.conversion.sarif-external-properties\",\n                        \"uriBaseId\": \"LOGSDIR\"\n                    },\n                    \"guid\": \"11111111-1111-1111-8888-111111111111\"\n                },\n                \"results\": [\n                    {\n                        \"location\": {\n                            \"uri\": \"scantool.results-1.sarif-external-properties\",\n                            \"uriBaseId\": \"LOGSDIR\"\n                        },\n                        \"guid\": \"22222222-2222-1111-8888-222222222222\",\n                        \"itemCount\": 1000\n                    },\n                    {\n                        \"location\": {\n                            \"uri\": \"scantool.results-2.sarif-external-properties\",\n                            \"uriBaseId\": \"LOGSDIR\"\n                        },\n                        \"guid\": \"33333333-3333-1111-8888-333333333333\",\n                        \"itemCount\": 4277\n                    }\n                ]\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/externalPropertyFileReferences/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/externalPropertyFileReferences.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/externalPropertyFileReferences.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\ExternalPropertyFileReference;\nuse Bartlett\\Sarif\\Definition\\ExternalPropertyFileReferences;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$run = new Run($tool);\n$logsDir = new ArtifactLocation();\n$logsDir-&gt;setUri('file:///C:/logs/');\n$run-&gt;addAdditionalProperties([\n    'LOGSDIR' =&gt; $logsDir,\n]);\n\n$location = new ArtifactLocation();\n$location-&gt;setUri('scantool.conversion.sarif-external-properties');\n$location-&gt;setUriBaseId('LOGSDIR');\n$conversion = new ExternalPropertyFileReference($location, '11111111-1111-1111-8888-111111111111');\n\n$location = new ArtifactLocation();\n$location-&gt;setUri('scantool.results-1.sarif-external-properties');\n$location-&gt;setUriBaseId('LOGSDIR');\n$resultRef1 = new ExternalPropertyFileReference($location, '22222222-2222-1111-8888-222222222222');\n$resultRef1-&gt;setItemCount(1000);\n\n$location = new ArtifactLocation();\n$location-&gt;setUri('scantool.results-2.sarif-external-properties');\n$location-&gt;setUriBaseId('LOGSDIR');\n$resultRef2 = new ExternalPropertyFileReference($location, '33333333-3333-1111-8888-333333333333');\n$resultRef2-&gt;setItemCount(4277);\n\n$externalPropertyFileReferences = new ExternalPropertyFileReferences();\n$externalPropertyFileReferences-&gt;setConversion($conversion);\n$externalPropertyFileReferences-&gt;addResults([$resultRef1, $resultRef2]);\n$run-&gt;setExternalPropertyFileReferences($externalPropertyFileReferences);\n</code></pre>"},{"location":"reference/fix/","title":"Fix","text":""},{"location":"reference/fix/#fix-object","title":"fix object","text":"<p>A <code>fix</code> object represents a proposed fix for the problem indicated by theResult. It specifies a set of artifacts to modify. For each artifact, it specifies regions to remove, and provides new content to insert.</p> <p></p>"},{"location":"reference/fix/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CA1001\",\n                    \"fixes\": [\n                        {\n                            \"artifactChanges\": [\n                                {\n                                    \"artifactLocation\": {\n                                        \"uri\": \"src/a.c\"\n                                    },\n                                    \"replacements\": [\n                                        {\n                                            \"deletedRegion\": {\n                                                \"startLine\": 1,\n                                                \"startColumn\": 1,\n                                                \"endLine\": 1\n                                            },\n                                            \"insertedContent\": {\n                                                \"text\": \"// \"\n                                            }\n                                        }\n                                    ]\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/fix/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/fix.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/fix.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactChange;\nuse Bartlett\\Sarif\\Definition\\ArtifactContent;\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Fix;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Replacement;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('src/a.c');\n$replacement = new Replacement(new Region(1, 1, 1));\n$insertedContent = new ArtifactContent();\n$insertedContent-&gt;setText('// ');\n$replacement-&gt;setInsertedContent($insertedContent);\n$artifactChange = new ArtifactChange($artifactLocation, [$replacement]);\n\n$fix = new Fix([$artifactChange]);\n\n$result = new Result(new Message('...'));\n$result-&gt;setRuleId('CA1001');\n$result-&gt;addFixes([$fix]);\n</code></pre>"},{"location":"reference/graph/","title":"Graph","text":""},{"location":"reference/graph/#graph-object","title":"graph object","text":"<p>A <code>graph</code> object represents a directed graph, a network of nodes and directed edges that describes some aspect of the structure of the code (for example, a call graph).</p> <p></p>"},{"location":"reference/graph/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"fullName\": \"CodeScanner 1.1, Developer Preview (en-US)\",\n                    \"version\": \"1.1.2b12\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Have a look on this graph\"\n                    },\n                    \"graphs\": [\n                        {\n                            \"nodes\": [\n                                {\n                                    \"id\": \"n2\"\n                                },\n                                {\n                                    \"id\": \"n3\"\n                                },\n                                {\n                                    \"id\": \"n4\"\n                                },\n                                {\n                                    \"id\": \"n1\",\n                                    \"children\": [\n                                        {\n                                            \"id\": \"n3\"\n                                        }\n                                    ]\n                                }\n                            ],\n                            \"edges\": [\n                                {\n                                    \"id\": \"e1\",\n                                    \"sourceNodeId\": \"n3\",\n                                    \"targetNodeId\": \"n4\"\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/graph/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/graph.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/graph.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Edge;\nuse Bartlett\\Sarif\\Definition\\Graph;\nuse Bartlett\\Sarif\\Definition\\Node;\n\n$nodes = [];\n$nodes[2] = new Node('n2');\n$nodes[3] = new Node('n3');\n$nodes[4] = new Node('n4');\n$nodes[1] = new Node('n1');\n$nodes[1]-&gt;addChildren([$nodes[3]]);\n\n$edges = [];\n$edges[1] = new Edge('e1', 'n3', 'n4');\n\n$graph = new Graph();\n$graph-&gt;addNodes($nodes);\n$graph-&gt;addEdges($edges);\n</code></pre>"},{"location":"reference/graphTraversal/","title":"graphTraversal","text":""},{"location":"reference/graphTraversal/#graphtraversal-object","title":"graphTraversal object","text":"<p>A <code>graphTraversal</code> object represents a \"graph traversal\", that is, a path through a graph specified by a sequence of connected \"edge traversals\", each of which is represented by an <code>edgeTraversal</code> object.</p> <p></p>"},{"location":"reference/graphTraversal/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"A graph and edge traversal objects\"\n                    },\n                    \"graphs\": [\n                        {\n                            \"nodes\": [\n                                {\n                                    \"id\": \"n1\"\n                                },\n                                {\n                                    \"id\": \"n2\"\n                                },\n                                {\n                                    \"id\": \"n3\"\n                                },\n                                {\n                                    \"id\": \"n4\"\n                                }\n                            ],\n                            \"edges\": [\n                                {\n                                    \"id\": \"e1\",\n                                    \"sourceNodeId\": \"n1\",\n                                    \"targetNodeId\": \"n2\"\n                                },\n                                {\n                                    \"id\": \"e2\",\n                                    \"sourceNodeId\": \"n2\",\n                                    \"targetNodeId\": \"n3\"\n                                },\n                                {\n                                    \"id\": \"e3\",\n                                    \"sourceNodeId\": \"n2\",\n                                    \"targetNodeId\": \"n4\"\n                                }\n                            ]\n                        }\n                    ],\n                    \"graphTraversals\": [\n                        {\n                            \"resultGraphIndex\": 0,\n                            \"initialState\": {\n                                \"x\": {\n                                    \"text\": \"1\"\n                                },\n                                \"y\": {\n                                    \"text\": \"2\"\n                                },\n                                \"x+y\": {\n                                    \"text\": \"3\"\n                                }\n                            },\n                            \"edgeTraversals\": [\n                                {\n                                    \"edgeId\": \"e1\",\n                                    \"finalState\": {\n                                        \"x\": {\n                                            \"text\": \"4\"\n                                        },\n                                        \"y\": {\n                                            \"text\": \"2\"\n                                        },\n                                        \"x+y\": {\n                                            \"text\": \"6\"\n                                        }\n                                    }\n                                },\n                                {\n                                    \"edgeId\": \"e3\",\n                                    \"finalState\": {\n                                        \"x\": {\n                                            \"text\": \"4\"\n                                        },\n                                        \"y\": {\n                                            \"text\": \"7\"\n                                        },\n                                        \"x+y\": {\n                                            \"text\": \"11\"\n                                        }\n                                    }\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/graphTraversal/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/graphTraversal.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/graphTraversal.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Edge;\nuse Bartlett\\Sarif\\Definition\\EdgeTraversal;\nuse Bartlett\\Sarif\\Definition\\Graph;\nuse Bartlett\\Sarif\\Definition\\GraphTraversal;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\Node;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$nodes = [];\n$nodes[1] = new Node('n1');\n$nodes[2] = new Node('n2');\n$nodes[3] = new Node('n3');\n$nodes[4] = new Node('n4');\n\n$edges = [];\n$edges[1] = new Edge('e1', 'n1', 'n2');\n$edges[2] = new Edge('e2', 'n2', 'n3');\n$edges[3] = new Edge('e3', 'n2', 'n4');\n\n$graph = new Graph();\n$graph-&gt;addNodes($nodes);\n$graph-&gt;addEdges($edges);\n\n$graphTraversal = new GraphTraversal(null, 0);\n$graphTraversal-&gt;addAdditionalPropertiesInitialState([\n    'x' =&gt; new MultiformatMessageString('1'),\n    'y' =&gt; new MultiformatMessageString('2'),\n    'x+y' =&gt; new MultiformatMessageString('3'),\n]);\n\n$edgeTraversal1 = new EdgeTraversal('e1');\n$edgeTraversal1-&gt;addAdditionalProperties([\n    'x' =&gt; new MultiformatMessageString('4'),\n    'y' =&gt; new MultiformatMessageString('2'),\n    'x+y' =&gt; new MultiformatMessageString('6'),\n]);\n$edgeTraversal3 = new EdgeTraversal('e3');\n$edgeTraversal3-&gt;addAdditionalProperties([\n    'x' =&gt; new MultiformatMessageString('4'),\n    'y' =&gt; new MultiformatMessageString('7'),\n    'x+y' =&gt; new MultiformatMessageString('11'),\n]);\n$graphTraversal-&gt;addEdgeTraversals([$edgeTraversal1, $edgeTraversal3]);\n\n$result = new Result(new Message('A graph and edge traversal objects'));\n$result-&gt;addGraphs([$graph]);\n$result-&gt;addGraphTraversals([$graphTraversal]);\n</code></pre>"},{"location":"reference/invocation/","title":"Invocation","text":""},{"location":"reference/invocation/#invocation-object","title":"invocation object","text":"<p>An <code>invocation</code> object describes the invocation of the analysis tool that was run.</p> <p></p>"},{"location":"reference/invocation/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CTN9999\",\n                            \"shortDescription\": {\n                                \"text\": \"First version of rule.\"\n                            }\n                        },\n                        {\n                            \"id\": \"CTN9999\",\n                            \"shortDescription\": {\n                                \"text\": \"Second version of rule.\"\n                            }\n                        }\n                    ]\n                }\n            },\n            \"invocations\": [\n                {\n                    \"executionSuccessful\": true,\n                    \"toolExecutionNotifications\": [\n                        {\n                            \"message\": {\n                                \"text\": \"Exception evaluating rule 'C2001'. Rule configuration is missing.\"\n                            },\n                            \"level\": \"error\",\n                            \"descriptor\": {\n                                \"index\": 1,\n                                \"id\": \"CTN9999\"\n                            }\n                        }\n                    ]\n                }\n            ],\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CTN9999\"\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/invocation/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/reportingDescriptorReference.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/reportingDescriptorReference.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Invocation;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\Notification;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptor;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptorReference;\nuse Bartlett\\Sarif\\Definition\\Result;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$notification = new Notification(new Message(\"Exception evaluating rule 'C2001'. Rule configuration is missing.\"));\n$notification-&gt;setAssociatedRule(new ReportingDescriptorReference(0, 'C2001'));\n$notification-&gt;setDescriptor(new ReportingDescriptorReference(1, 'CTN9999'));\n$notification-&gt;setLevel('error');\n$invocation = new Invocation(true);\n$invocation-&gt;addToolExecutionNotifications([$notification]);\n\n$result = new Result(new Message('...'));\n$result-&gt;setRuleId('CTN9999');\n\n$run = new Run($tool);\n$run-&gt;addResults([$result]);\n$run-&gt;addInvocations([$invocation]);\n</code></pre>"},{"location":"reference/locationRelationship/","title":"locationRelationship","text":""},{"location":"reference/locationRelationship/#locationrelationship-object","title":"locationRelationship object","text":"<p>A <code>locationRelationship</code> object specifies one or more directed relationships from one location object, which we refer to as theSource, to another one, which we refer to as theTarget.</p> <p></p>"},{"location":"reference/locationRelationship/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"A result object with locationRelationship object\"\n                    },\n                    \"locations\": [\n                        {\n                            \"id\": 0,\n                            \"physicalLocation\": {\n                                \"artifactLocation\": {\n                                    \"uri\": \"f.h\"\n                                },\n                                \"region\": {\n                                    \"startLine\": 42\n                                }\n                            },\n                            \"relationships\": [\n                                {\n                                    \"target\": 1,\n                                    \"kinds\": [\n                                        \"isIncludedBy\"\n                                    ]\n                                }\n                            ]\n                        }\n                    ],\n                    \"relatedLocations\": [\n                        {\n                            \"id\": 1,\n                            \"physicalLocation\": {\n                                \"artifactLocation\": {\n                                    \"uri\": \"g.h\"\n                                },\n                                \"region\": {\n                                    \"startLine\": 17\n                                }\n                            },\n                            \"relationships\": [\n                                {\n                                    \"target\": 0,\n                                    \"kinds\": [\n                                        \"includes\"\n                                    ]\n                                },\n                                {\n                                    \"target\": 2,\n                                    \"kinds\": [\n                                        \"isIncludedBy\"\n                                    ]\n                                }\n                            ]\n                        },\n                        {\n                            \"id\": 2,\n                            \"physicalLocation\": {\n                                \"artifactLocation\": {\n                                    \"uri\": \"g.c\"\n                                },\n                                \"region\": {\n                                    \"startLine\": 8\n                                }\n                            },\n                            \"relationships\": [\n                                {\n                                    \"target\": 1,\n                                    \"kinds\": [\n                                        \"includes\"\n                                    ]\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/locationRelationship/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/locationRelationship.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/locationRelationship.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Location;\nuse Bartlett\\Sarif\\Definition\\LocationRelationship;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\PhysicalLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$location = [];\n$physicalLocation = [];\n$artifactLocation = [];\n$region = [];\n$relationships = [];\n\n$location[0] = new Location();\n$location[0]-&gt;setId(0);\n$artifactLocation[0] = new ArtifactLocation();\n$artifactLocation[0]-&gt;setUri('f.h');\n$physicalLocation[0] = new PhysicalLocation($artifactLocation[0]);\n$region[0] = new Region(42);\n$physicalLocation[0]-&gt;setRegion($region[0]);\n$location[0]-&gt;setPhysicalLocation($physicalLocation[0]);\n$relationships[0] = new LocationRelationship(1);\n$relationships[0]-&gt;addKinds(['isIncludedBy']);\n$location[0]-&gt;addRelationships([$relationships[0]]);\n\n$location[1] = new Location();\n$location[1]-&gt;setId(1);\n$artifactLocation[1] = new ArtifactLocation();\n$artifactLocation[1]-&gt;setUri('g.h');\n$physicalLocation[1] = new PhysicalLocation($artifactLocation[1]);\n$region[1] = new Region(17);\n$physicalLocation[1]-&gt;setRegion($region[1]);\n$location[1]-&gt;setPhysicalLocation($physicalLocation[1]);\n$relationships[1] = new LocationRelationship(0);\n$relationships[1]-&gt;addKinds(['includes']);\n$relationships[2] = new LocationRelationship(2);\n$relationships[2]-&gt;addKinds(['isIncludedBy']);\n$location[1]-&gt;addRelationships([$relationships[1], $relationships[2]]);\n\n$location[2] = new Location();\n$location[2]-&gt;setId(2);\n$artifactLocation[2] = new ArtifactLocation();\n$artifactLocation[2]-&gt;setUri('g.c');\n$physicalLocation[2] = new PhysicalLocation($artifactLocation[2]);\n$region[2] = new Region(8);\n$physicalLocation[2]-&gt;setRegion($region[2]);\n$location[2]-&gt;setPhysicalLocation($physicalLocation[2]);\n$relationships[2] = new LocationRelationship(1);\n$relationships[2]-&gt;addKinds(['includes']);\n$location[2]-&gt;addRelationships([$relationships[2]]);\n\n$result = new Result(new Message('A result object with locationRelationship object'));\n$result-&gt;addLocations([$location[0]]);\n$result-&gt;addRelatedLocations([$location[1], $location[2]]);\n</code></pre>"},{"location":"reference/logicalLocation/","title":"logicalLocation","text":""},{"location":"reference/logicalLocation/#logicallocation-object","title":"logicalLocation object","text":"<p>A <code>logicalLocation</code> object describes a logical location. A logical location is a location specified by a programmatic construct such as a namespace, a type, or a method, without regard to the physical location where the construct occurs.</p> <p></p>"},{"location":"reference/logicalLocation/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"Psalm\",\n                    \"version\": \"4.x-dev\",\n                    \"informationUri\": \"https://psalm.de\"\n                }\n            },\n            \"logicalLocations\": [\n                {\n                    \"name\": \"Hook\",\n                    \"fullyQualifiedName\": \"Psalm\\\\Plugin\\\\Hook\",\n                    \"kind\": \"namespace\"\n                },\n                {\n                    \"name\": \"afterAnalysis\",\n                    \"fullyQualifiedName\": \"Psalm\\\\Plugin\\\\Hook\\\\AfterAnalysisInterface\\\\afterAnalysis\",\n                    \"kind\": \"function\"\n                }\n            ],\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/logicalLocation/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/logicalLocation.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/logicalLocation.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\LogicalLocation;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$nsLocation = new LogicalLocation();\n$nsLocation-&gt;setName('Hook');\n$nsLocation-&gt;setFullyQualifiedName('Psalm\\Plugin\\Hook');\n$nsLocation-&gt;setKind('namespace');\n\n$funcLocation = new LogicalLocation();\n$funcLocation-&gt;setName('afterAnalysis');\n$funcLocation-&gt;setFullyQualifiedName('Psalm\\Plugin\\Hook\\AfterAnalysisInterface\\afterAnalysis');\n$funcLocation-&gt;setKind('function');\n\n$run = new Run($tool);\n$run-&gt;addLogicalLocations([$nsLocation, $funcLocation]);\n</code></pre>"},{"location":"reference/message/","title":"Message","text":""},{"location":"reference/message/#message-object","title":"message object","text":"<p>Certain objects in this document define messages intended to be viewed by a user. SARIF represents such a message with a <code>message</code> object, which offers the following features:</p> <ul> <li>Message strings in plain text (\u201cplain text messages\u201d).</li> <li>Message strings that incorporate formatting information (\u201cformatted messages\u201d) in GitHub Flavored Markdown.</li> <li>Message strings with placeholders for variable information.</li> <li>Message strings with embedded links.</li> </ul> <p></p>"},{"location":"reference/message/#plaintext-example","title":"PlainText Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"ESLint\",\n                    \"semanticVersion\": \"8.1.0\",\n                    \"informationUri\": \"https://eslint.org\",\n                    \"rules\": [\n                        {\n                            \"id\": \"no-unused-vars\",\n                            \"shortDescription\": {\n                                \"text\": \"disallow unused variables\"\n                            },\n                            \"helpUri\": \"https://eslint.org/docs/rules/no-unused-vars\",\n                            \"properties\": {\n                                \"category\": \"Variables\"\n                            }\n                        }\n                    ]\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"'x' is assigned a value but never used.\"\n                    },\n                    \"ruleId\": \"no-unused-vars\",\n                    \"ruleIndex\": 0,\n                    \"level\": \"error\"\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/message/#formatted-example","title":"Formatted Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Variable '{0}' is uninitialized.\",\n                        \"arguments\": [\n                            \"pBuffer\"\n                        ]\n                    },\n                    \"ruleId\": \"CA2101\"\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/message/#embedded-links-example","title":"Embedded links Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Tainted data was used. The data came from [here](3).\"\n                    },\n                    \"ruleId\": \"TNT0001\",\n                    \"relatedLocations\": [\n                        {\n                            \"id\": 3,\n                            \"physicalLocation\": {\n                                \"artifactLocation\": {\n                                    \"uri\": \"file:///C:/code/input.c\"\n                                },\n                                \"region\": {\n                                    \"startLine\": 25,\n                                    \"startColumn\": 19\n                                }\n                            }\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/message/#string-lookup-example","title":"String lookup Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CS0001\",\n                            \"messageStrings\": {\n                                \"default\": {\n                                    \"text\": \"This is the message text. It might be very long.\"\n                                }\n                            }\n                        }\n                    ]\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"id\": \"default\"\n                    },\n                    \"ruleId\": \"CS0001\",\n                    \"ruleIndex\": 0\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/message/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/message/plainText.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/plainText.php</code> script into repository.</p> <pre><code>&lt;?php\n\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$message = new Message(\"'x' is assigned a value but never used.\");\n$result = new Result($message);\n$result-&gt;setLevel('error');\n$result-&gt;setRuleId('no-unused-vars');\n$result-&gt;setRuleIndex(0);\n</code></pre> <p>See full <code>examples/message/formatted.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/formatted.php</code> script into repository.</p> <pre><code>&lt;?php\n\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$message = new Message(\"Variable '{0}' is uninitialized.\");\n$message-&gt;addArguments(['pBuffer']);\n$result = new Result($message);\n$result-&gt;setRuleId('CA2101');\n</code></pre> <p>See full <code>examples/message/embeddedLinks.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/embeddedLinks.php</code> script into repository.</p> <pre><code>&lt;?php\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Location;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\PhysicalLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$message = new Message('Tainted data was used. The data came from [here](3).');\n$result = new Result($message);\n$result-&gt;setRuleId('TNT0001');\n$location = new Location();\n$location-&gt;setId('3');\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('file:///C:/code/input.c');\n$physicalLocation = new PhysicalLocation($artifactLocation);\n$physicalLocation-&gt;setRegion(new Region(25, 19));\n$location-&gt;setPhysicalLocation($physicalLocation);\n$result-&gt;addRelatedLocations([$location]);\n</code></pre> <p>See full <code>examples/message/stringLookup.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/stringLookup.php</code> script into repository.</p> <pre><code>&lt;?php\n\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptor;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$rule = new ReportingDescriptor('no-unused-vars');\n$rule-&gt;setId('CS0001');\n$rule-&gt;addMessageStrings([\n    'default' =&gt; new MultiformatMessageString('This is the message text. It might be very long.'),\n]);\n\n$message = new Message(\n    'A message object can directly contain message strings in its text and markdown properties.'\n    . ' It can also indirectly refer to message strings through its id property.'\n);\n$result = new Result($message);\n$result-&gt;setRuleId('CS0001');\n$result-&gt;setRuleIndex(0);\n$result-&gt;setMessage(new Message('', 'default'));\n</code></pre>"},{"location":"reference/node/","title":"Node","text":""},{"location":"reference/node/#node-object","title":"node object","text":"<p>A <code>node</code> object represents a node in the graph represented by the containing graph object, which we refer to as theGraph.</p> <p></p>"},{"location":"reference/node/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"fullName\": \"CodeScanner 1.1, Developer Preview (en-US)\",\n                    \"version\": \"1.1.2b12\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Have a look on this graph\"\n                    },\n                    \"graphs\": [\n                        {\n                            \"nodes\": [\n                                {\n                                    \"id\": \"n2\"\n                                },\n                                {\n                                    \"id\": \"n3\"\n                                },\n                                {\n                                    \"id\": \"n4\"\n                                },\n                                {\n                                    \"id\": \"n1\",\n                                    \"children\": [\n                                        {\n                                            \"id\": \"n3\"\n                                        }\n                                    ]\n                                }\n                            ],\n                            \"edges\": [\n                                {\n                                    \"id\": \"e1\",\n                                    \"sourceNodeId\": \"n3\",\n                                    \"targetNodeId\": \"n4\"\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/node/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/graph.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/graph.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Edge;\nuse Bartlett\\Sarif\\Definition\\Graph;\nuse Bartlett\\Sarif\\Definition\\Node;\n\n$nodes = [];\n$nodes[2] = new Node('n2');\n$nodes[3] = new Node('n3');\n$nodes[4] = new Node('n4');\n$nodes[1] = new Node('n1');\n$nodes[1]-&gt;addChildren([$nodes[3]]);\n\n$edges = [];\n$edges[1] = new Edge('e1', 'n3', 'n4');\n\n$graph = new Graph();\n$graph-&gt;addNodes($nodes);\n$graph-&gt;addEdges($edges);\n</code></pre>"},{"location":"reference/notification/","title":"Notification","text":""},{"location":"reference/notification/#notification-object","title":"notification object","text":"<p>A <code>notification</code> object describes a condition encountered during the execution of an analysis tool which is relevant to the operation of the tool itself, as opposed to being relevant to an artifact being analyzed by the tool. Conditions relevant to artifacts being analyzed by a tool are represented by <code>result</code> objects.</p> <p></p>"},{"location":"reference/notification/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CTN9999\",\n                            \"shortDescription\": {\n                                \"text\": \"First version of rule.\"\n                            }\n                        },\n                        {\n                            \"id\": \"CTN9999\",\n                            \"shortDescription\": {\n                                \"text\": \"Second version of rule.\"\n                            }\n                        }\n                    ]\n                }\n            },\n            \"invocations\": [\n                {\n                    \"executionSuccessful\": true,\n                    \"toolExecutionNotifications\": [\n                        {\n                            \"message\": {\n                                \"text\": \"Exception evaluating rule 'C2001'. Rule configuration is missing.\"\n                            },\n                            \"level\": \"error\",\n                            \"descriptor\": {\n                                \"index\": 1,\n                                \"id\": \"CTN9999\"\n                            }\n                        }\n                    ]\n                }\n            ],\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CTN9999\"\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/notification/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/reportingDescriptorReference.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/reportingDescriptorReference.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Invocation;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Notification;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptorReference;\n\n$notification = new Notification(new Message(\"Exception evaluating rule 'C2001'. Rule configuration is missing.\"));\n$notification-&gt;setAssociatedRule(new ReportingDescriptorReference(0, 'C2001'));\n$notification-&gt;setDescriptor(new ReportingDescriptorReference(1, 'CTN9999'));\n$notification-&gt;setLevel('error');\n$invocation = new Invocation(true);\n$invocation-&gt;addToolExecutionNotifications([$notification]);\n</code></pre>"},{"location":"reference/physicalLocation/","title":"physicalLocation","text":""},{"location":"reference/physicalLocation/#physicallocation-object","title":"physicalLocation object","text":"<p>A <code>physicalLocation</code> object represents the physical location where a result was detected. A physical location specifies a reference to an artifact together with a region within that artifact.</p> <p></p>"},{"location":"reference/physicalLocation/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Identify a physical location where a result was detected.\"\n                    },\n                    \"locations\": [\n                        {\n                            \"physicalLocation\": {\n                                \"artifactLocation\": {\n                                    \"uri\": \"ui/window.c\",\n                                    \"uriBaseId\": \"SRCROOT\"\n                                },\n                                \"region\": {\n                                    \"startLine\": 42\n                                }\n                            }\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/physicalLocation/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/physicalLocation.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/physicalLocation.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Location;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\PhysicalLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('ui/window.c');\n$artifactLocation-&gt;setUriBaseId('SRCROOT');\n\n$result = new Result(new Message('Identify a physical location where a result was detected.'));\n$location = new Location();\n$physicalLocation = new PhysicalLocation($artifactLocation);\n$physicalLocation-&gt;setRegion(new Region(42));\n$location-&gt;setPhysicalLocation($physicalLocation);\n$result-&gt;addLocations([$location]);\n</code></pre>"},{"location":"reference/rectangle/","title":"Rectangle","text":""},{"location":"reference/rectangle/#rectangle-object","title":"rectangle object","text":"<p>A <code>rectangle</code> object specifies a rectangular area within an image. When a SARIF viewer displays an image, it MAY indicate the presence of these areas, for example, by highlighting them or surrounding them with a border.</p> <p></p>"},{"location":"reference/rectangle/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"fullName\": \"CodeScanner 1.1, Developer Preview (en-US)\",\n                    \"version\": \"1.1.2b12\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Have a look on screen shot provided\"\n                    },\n                    \"attachments\": [\n                        {\n                            \"artifactLocation\": {\n                                \"uri\": \"file:///C:/ScanOutput/image001.png\"\n                            },\n                            \"description\": {\n                                \"text\": \"Screen shot\"\n                            },\n                            \"rectangles\": [\n                                {\n                                    \"top\": 80,\n                                    \"left\": 10,\n                                    \"bottom\": 5,\n                                    \"right\": 90\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/rectangle/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/rectangle.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/rectangle.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Attachment;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Rectangle;\nuse Bartlett\\Sarif\\Definition\\Result;\n\n$attachment = new Attachment();\n$attachment-&gt;setDescription(new Message('Screen shot'));\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('file:///C:/ScanOutput/image001.png');\n$attachment-&gt;setArtifactLocation($artifactLocation);\n$rectangle = new Rectangle();\n$rectangle-&gt;setTop(80);\n$rectangle-&gt;setLeft(10);\n$rectangle-&gt;setBottom(5);\n$rectangle-&gt;setRight(90);\n$attachment-&gt;addRectangles([$rectangle]);\n\n$result = new Result(new Message('Have a look on screen shot provided'));\n$result-&gt;addAttachments([$attachment]);\n</code></pre>"},{"location":"reference/replacement/","title":"Replacement","text":""},{"location":"reference/replacement/#replacement-object","title":"replacement object","text":"<p>A <code>replacement</code> object represents the replacement of a single region of an artifact.</p> <p></p>"},{"location":"reference/replacement/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CA1001\",\n                    \"fixes\": [\n                        {\n                            \"artifactChanges\": [\n                                {\n                                    \"artifactLocation\": {\n                                        \"uri\": \"src/a.c\"\n                                    },\n                                    \"replacements\": [\n                                        {\n                                            \"deletedRegion\": {\n                                                \"startLine\": 1,\n                                                \"startColumn\": 1,\n                                                \"endLine\": 1\n                                            },\n                                            \"insertedContent\": {\n                                                \"text\": \"// \"\n                                            }\n                                        }\n                                    ]\n                                }\n                            ]\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/replacement/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/fix.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/fix.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactChange;\nuse Bartlett\\Sarif\\Definition\\ArtifactContent;\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Replacement;\n\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('src/a.c');\n$replacement = new Replacement(new Region(1, 1, 1));\n$insertedContent = new ArtifactContent();\n$insertedContent-&gt;setText('// ');\n$replacement-&gt;setInsertedContent($insertedContent);\n$artifactChange = new ArtifactChange($artifactLocation, [$replacement]);\n</code></pre>"},{"location":"reference/reportingConfiguration/","title":"reportingConfiguration","text":""},{"location":"reference/reportingConfiguration/#reportingconfiguration-object","title":"reportingConfiguration object","text":"<p>A <code>reportingConfiguration</code> object contains the information in a <code>reportingDescriptor</code> that a SARIF producer can modify at runtime, before executing its scan.</p> <p></p>"},{"location":"reference/reportingConfiguration/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"SA2707\",\n                            \"name\": \"LimitSourceLineLength\",\n                            \"shortDescription\": {\n                                \"text\": \"Limit source line length for readability.\"\n                            },\n                            \"defaultConfiguration\": {\n                                \"enabled\": true,\n                                \"level\": \"warning\",\n                                \"rank\": -1,\n                                \"parameters\": {\n                                    \"maxLength\": 120\n                                }\n                            }\n                        }\n                    ]\n                }\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/reportingConfiguration/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/reportingConfiguration.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/reportingConfiguration.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\PropertyBag;\nuse Bartlett\\Sarif\\Definition\\ReportingConfiguration;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptor;\n\n$rule = new ReportingDescriptor('SA2707');\n$rule-&gt;setName('LimitSourceLineLength');\n$rule-&gt;setShortDescription(new MultiformatMessageString('Limit source line length for readability.'));\n$reportingConf = new ReportingConfiguration();\n$propertyBag = new PropertyBag();\n$propertyBag-&gt;addProperty('maxLength', 120);\n$reportingConf-&gt;setParameters($propertyBag);\n$rule-&gt;setDefaultConfiguration($reportingConf);\n</code></pre>"},{"location":"reference/reportingDescriptor/","title":"reportingDescriptor","text":""},{"location":"reference/reportingDescriptor/#reportingdescriptor-object","title":"reportingDescriptor object","text":"<p>A <code>reportingDescriptor</code> object contains information that describes a \"reporting item\" generated by a tool.</p> <p></p>"},{"location":"reference/reportingDescriptor/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CA1001\",\n                            \"deprecatedIds\": [\n                                \"CA1000\"\n                            ]\n                        },\n                        {\n                            \"id\": \"CA1002\",\n                            \"deprecatedIds\": [\n                                \"CA1000\"\n                            ]\n                        }\n                    ]\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CA1001\",\n                    \"suppressions\": [\n                        {\n                            \"kind\": \"inSource\"\n                        }\n                    ],\n                    \"baselineState\": \"unchanged\"\n                },\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CA1002\",\n                    \"suppressions\": [\n                        {\n                            \"kind\": \"inSource\"\n                        }\n                    ],\n                    \"baselineState\": \"updated\"\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/reportingDescriptor/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/reportingDescriptor.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/reportingDescriptor.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptor;\nuse Bartlett\\Sarif\\Definition\\ToolComponent;\n\n$driver = new ToolComponent('CodeScanner');\n\n$rule1 = new ReportingDescriptor('CA1001');\n$rule1-&gt;addDeprecatedIds(['CA1000']);\n$rule2 = new ReportingDescriptor('CA1002');\n$rule2-&gt;addDeprecatedIds(['CA1000']);\n$driver-&gt;addRules([$rule1, $rule2]);\n</code></pre>"},{"location":"reference/reportingDescriptorReference/","title":"reportingDescriptorReference","text":""},{"location":"reference/reportingDescriptorReference/#reportingdescriptorreference-object","title":"reportingDescriptorReference object","text":"<p>A <code>reportingDescriptorReference</code> object identifies a particular <code>reportingDescriptor</code> object, which we refer to as theDescriptor, among all <code>reportingDescriptor</code> objects defined by theTool, including those defined by theTool.driver and theTool.extensions.</p> <p></p>"},{"location":"reference/reportingDescriptorReference/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CTN9999\",\n                            \"shortDescription\": {\n                                \"text\": \"First version of rule.\"\n                            }\n                        },\n                        {\n                            \"id\": \"CTN9999\",\n                            \"shortDescription\": {\n                                \"text\": \"Second version of rule.\"\n                            }\n                        }\n                    ]\n                }\n            },\n            \"invocations\": [\n                {\n                    \"executionSuccessful\": true,\n                    \"toolExecutionNotifications\": [\n                        {\n                            \"message\": {\n                                \"text\": \"Exception evaluating rule 'C2001'. Rule configuration is missing.\"\n                            },\n                            \"level\": \"error\",\n                            \"descriptor\": {\n                                \"index\": 1,\n                                \"id\": \"CTN9999\"\n                            }\n                        }\n                    ]\n                }\n            ],\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"...\"\n                    },\n                    \"ruleId\": \"CTN9999\"\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/reportingDescriptorReference/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/reportingDescriptorReference.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/reportingDescriptorReference.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Invocation;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Notification;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptorReference;\n\n$notification = new Notification(new Message(\"Exception evaluating rule 'C2001'. Rule configuration is missing.\"));\n$notification-&gt;setAssociatedRule(new ReportingDescriptorReference(0, 'C2001'));\n$notification-&gt;setDescriptor(new ReportingDescriptorReference(1, 'CTN9999'));\n$notification-&gt;setLevel('error');\n$invocation = new Invocation(true);\n$invocation-&gt;addToolExecutionNotifications([$notification]);\n</code></pre>"},{"location":"reference/reportingDescriptorRelationship/","title":"reportingDescriptorRelationship","text":""},{"location":"reference/reportingDescriptorRelationship/#reportingdescriptorrelationship-object","title":"reportingDescriptorRelationship object","text":"<p>A <code>reportingDescriptorRelationship</code> object specifies one or more directed relationships from one <code>reportingDescriptor</code> object, which we refer to as theSource, to another one, which we refer to as theTarget.</p> <p></p>"},{"location":"reference/reportingDescriptorRelationship/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CA1000\",\n                            \"relationships\": [\n                                {\n                                    \"target\": {\n                                        \"index\": 0,\n                                        \"id\": \"327\",\n                                        \"guid\": \"33333333-0000-1111-8888-111111111111\",\n                                        \"toolComponent\": {\n                                            \"name\": \"CWE\",\n                                            \"guid\": \"33333333-0000-1111-8888-000000000000\"\n                                        }\n                                    },\n                                    \"kinds\": [\n                                        \"superset\"\n                                    ]\n                                }\n                            ]\n                        }\n                    ]\n                }\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/reportingDescriptorRelationship/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/reportingDescriptorRelationship.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/reportingDescriptorRelationship.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptor;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptorReference;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptorRelationship;\nuse Bartlett\\Sarif\\Definition\\ToolComponentReference;\n\n$rule = new ReportingDescriptor('CA1000');\n\n$target = new ReportingDescriptorReference(0, '327', '33333333-0000-1111-8888-111111111111');\n$toolComponent = new ToolComponentReference();\n$toolComponent-&gt;setName('CWE');\n$toolComponent-&gt;setGuid('33333333-0000-1111-8888-000000000000');\n$target-&gt;setToolComponent($toolComponent);\n\n$relationship = new ReportingDescriptorRelationship($target);\n$relationship-&gt;addKinds(['superset']);\n$rule-&gt;addRelationships([$relationship]);\n</code></pre>"},{"location":"reference/result/","title":"Result","text":""},{"location":"reference/result/#result-object","title":"result object","text":"<p>A <code>result</code> object describes a single result detected by an analysis tool.</p> <p></p>"},{"location":"reference/result/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CA2101\",\n                            \"shortDescription\": {\n                                \"text\": \"Specify marshaling for P/Invoke string arguments.\"\n                            }\n                        },\n                        {\n                            \"id\": \"CA5350\",\n                            \"shortDescription\": {\n                                \"text\": \"Do not use weak cryptographic algorithms.\"\n                            }\n                        }\n                    ]\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Result on rule 0\"\n                    },\n                    \"ruleId\": \"CA2101\",\n                    \"ruleIndex\": 0\n                },\n                {\n                    \"message\": {\n                        \"text\": \"Result on rule 1\"\n                    },\n                    \"ruleId\": \"CA5350/md5\",\n                    \"ruleIndex\": 1\n                },\n                {\n                    \"message\": {\n                        \"text\": \"Another result on rule 1\"\n                    },\n                    \"ruleId\": \"CA5350/sha-1\",\n                    \"ruleIndex\": 1\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/result/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/result.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/result.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Result;\nuse Bartlett\\Sarif\\Definition\\Run;\n\n$result1 = new Result(new Message('Result on rule 0'));\n$result1-&gt;setRuleId('CA2101');\n$result1-&gt;setRuleIndex(0);\n\n$result2 = new Result(new Message('Result on rule 1'));\n$result2-&gt;setRuleId('CA5350/md5');\n$result2-&gt;setRuleIndex(1);\n\n$result3 = new Result(new Message('Another result on rule 1'));\n$result3-&gt;setRuleId('CA5350/sha-1');\n$result3-&gt;setRuleIndex(1);\n\n$run = new Run($tool);\n$run-&gt;addResults([$result1, $result2, $result3]);\n</code></pre>"},{"location":"reference/resultProvenance/","title":"resultProvenance","text":""},{"location":"reference/resultProvenance/#resultprovenance-object","title":"resultProvenance object","text":"<p>A <code>resultProvenance</code> object contains information about the how and when theResult was detected.</p> <p></p>"},{"location":"reference/resultProvenance/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"SarifSamples\",\n                    \"version\": \"1.0\",\n                    \"informationUri\": \"https://github.com/microsoft/sarif-tutorials/\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Assertions are unreliable.\"\n                    },\n                    \"ruleId\": \"Assertions\",\n                    \"provenance\": {\n                        \"conversionSources\": [\n                            {\n                                \"artifactLocation\": {\n                                    \"uri\": \"CodeScanner.log\",\n                                    \"uriBaseId\": \"LOGSROOT\"\n                                },\n                                \"region\": {\n                                    \"startLine\": 3,\n                                    \"startColumn\": 3,\n                                    \"endLine\": 12,\n                                    \"endColumn\": 13,\n                                    \"snippet\": {\n                                        \"text\": \"&lt;problem&gt;...&lt;/problem&gt;\"\n                                    }\n                                }\n                            }\n                        ]\n                    }\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/resultProvenance/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/resultProvenance.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/resultProvenance.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactContent;\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\PhysicalLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Result;\nuse Bartlett\\Sarif\\Definition\\ResultProvenance;\n\n$provenance = new ResultProvenance();\n$fromSources = [];\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('CodeScanner.log');\n$artifactLocation-&gt;setUriBaseId('LOGSROOT');\n$fromSources[0] = new PhysicalLocation($artifactLocation);\n$region = new Region(3, 3, 12, 13);\n$snippet = new ArtifactContent();\n$snippet-&gt;setText('&lt;problem&gt;...&lt;/problem&gt;');\n$region-&gt;setSnippet($snippet);\n$fromSources[0]-&gt;setRegion($region);\n\n$provenance-&gt;addConversionSources($fromSources);\n\n$result = new Result(new Message('Assertions are unreliable.'));\n$result-&gt;setProvenance($provenance);\n</code></pre>"},{"location":"reference/run/","title":"Run","text":""},{"location":"reference/run/#run-object","title":"run object","text":"<p>A <code>run</code> object describes a single run of an analysis tool and contains the output of that run.</p> <p></p>"},{"location":"reference/run/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"Psalm\",\n                    \"version\": \"4.x-dev\",\n                    \"informationUri\": \"https://psalm.de\"\n                }\n            },\n            \"properties\": {\n                \"stableId\": \"Nightly static analysis run\"\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/run/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/run.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/run.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Run;\nuse Bartlett\\Sarif\\Definition\\Tool;\nuse Bartlett\\Sarif\\Definition\\ToolComponent;\n\n$driver = new ToolComponent('Psalm');\n$tool = new Tool($driver);\n\n$run = new Run($tool);\n</code></pre>"},{"location":"reference/runAutomationDetails/","title":"runAutomationDetails","text":""},{"location":"reference/runAutomationDetails/#runautomationdetails-object","title":"runAutomationDetails object","text":"<p>A <code>runAutomationDetails</code> object contains information that specifies theRun\u2019s identity and role within an engineering system.</p> <p></p>"},{"location":"reference/runAutomationDetails/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"fullName\": \"CodeScanner 1.1, Developer Preview (en-US)\",\n                    \"version\": \"1.1.2b12\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"automationDetails\": {\n                \"description\": {\n                    \"text\": \"This is the {0} nightly run of the Credential Scanner tool on all product binaries in the '{1}' branch of the '{2}' repo. The scanned binaries are architecture '{3}' and build type '{4}'.\",\n                    \"arguments\": [\n                        \"October 10, 2018\",\n                        \"master\",\n                        \"sarif-sdk\",\n                        \"x86\",\n                        \"debug\"\n                    ]\n                },\n                \"id\": \"Nightly CredScan run for sarif-sdk/master/x86/debug/2018-10-05\",\n                \"guid\": \"11111111-1111-1111-8888-111111111111\",\n                \"correlationGuid\": \"22222222-2222-1111-8888-222222222222\"\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/runAutomationDetails/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/runAutomationDetails.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/runAutomationDetails.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Run;\nuse Bartlett\\Sarif\\Definition\\RunAutomationDetails;\n\n$automationDetails = new RunAutomationDetails();\n\n$text = \"This is the {0} nightly run of the Credential Scanner tool on\" .\n    \" all product binaries in the '{1}' branch of the '{2}' repo.\".\n    \" The scanned binaries are architecture '{3}' and build type '{4}'.\";\n$description = new Message($text);\n$description-&gt;addArguments([\n    \"October 10, 2018\",\n    \"master\",\n    \"sarif-sdk\",\n    \"x86\",\n    \"debug\",\n]);\n$automationDetails-&gt;setDescription($description);\n$automationDetails-&gt;setId('Nightly CredScan run for sarif-sdk/master/x86/debug/2018-10-05');\n$automationDetails-&gt;setGuid('11111111-1111-1111-8888-111111111111');\n$automationDetails-&gt;setCorrelationGuid('22222222-2222-1111-8888-222222222222');\n\n$run = new Run($tool);\n$run-&gt;setAutomationDetails($automationDetails);\n</code></pre>"},{"location":"reference/sarifLog/","title":"sarifLog","text":""},{"location":"reference/sarifLog/#sariflog-object","title":"sarifLog object","text":"<p>A <code>sarifLog</code> object specifies the version of the file format and contains the output from one or more runs.</p> <p></p>"},{"location":"reference/sarifLog/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": []\n}\n</code></pre>"},{"location":"reference/sarifLog/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/sarifLog.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/sarifLog.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\SarifLog;\n\n$log = new SarifLog();\n</code></pre>"},{"location":"reference/specialLocations/","title":"specialLocations","text":""},{"location":"reference/specialLocations/#speciallocations-object","title":"specialLocations object","text":"<p>A <code>specialLocations</code> object defines locations of special significance to SARIF consumers.</p> <p></p>"},{"location":"reference/specialLocations/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"originalUriBaseIds\": {\n                \"WEBHOST\": {\n                    \"uri\": \"http://www.example.com/\"\n                },\n                \"ROOT\": {\n                    \"uri\": \"file:///\"\n                },\n                \"HOME\": {\n                    \"uri\": \"home/user/\",\n                    \"uriBaseId\": \"ROOT\"\n                },\n                \"PACKAGE\": {\n                    \"uri\": \"mySoftware/\",\n                    \"uriBaseId\": \"HOME\"\n                },\n                \"SRC\": {\n                    \"uri\": \"src/\",\n                    \"uriBaseId\": \"PACKAGE\"\n                }\n            },\n            \"specialLocations\": {\n                \"displayBase\": {\n                    \"uriBaseId\": \"PACKAGE\"\n                }\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/specialLocations/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/specialLocations.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/specialLocations.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Run;\nuse Bartlett\\Sarif\\Definition\\SpecialLocations;\n\n$package = new ArtifactLocation();\n$package-&gt;setUri('mySoftware/');\n$package-&gt;setUriBaseId('HOME');\n\n$run = new Run($tool);\n$run-&gt;addAdditionalProperties([\n    'PACKAGE' =&gt; $package,\n]);\n\n$specialLocations = new SpecialLocations();\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('');\n$artifactLocation-&gt;setUriBaseId('PACKAGE');\n$specialLocations-&gt;setDisplayBase($artifactLocation);\n\n$run-&gt;setSpecialLocations($specialLocations);\n</code></pre>"},{"location":"reference/stack/","title":"Stack","text":""},{"location":"reference/stack/#stack-object","title":"stack object","text":"<p>A <code>stack</code> object describes a single call stack. A call stack is a sequence of nested function calls, each of which is referred to as a stack frame.</p> <p></p>"},{"location":"reference/stack/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"SarifSamples\",\n                    \"version\": \"1.0\",\n                    \"informationUri\": \"https://github.com/microsoft/sarif-tutorials/\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Uninitialized variable.\"\n                    },\n                    \"ruleId\": \"TUT1001\",\n                    \"locations\": [\n                        {\n                            \"physicalLocation\": {\n                                \"artifactLocation\": {\n                                    \"uri\": \"collections/list.h\",\n                                    \"uriBaseId\": \"SRCROOT\"\n                                },\n                                \"region\": {\n                                    \"startLine\": 15\n                                }\n                            },\n                            \"logicalLocations\": [\n                                {\n                                    \"fullyQualifiedName\": \"collections::list::add\"\n                                }\n                            ]\n                        }\n                    ],\n                    \"stacks\": [\n                        {\n                            \"frames\": [\n                                {\n                                    \"location\": {\n                                        \"physicalLocation\": {\n                                            \"artifactLocation\": {\n                                                \"uri\": \"collections/list.h\",\n                                                \"uriBaseId\": \"SRCROOT\"\n                                            },\n                                            \"region\": {\n                                                \"startLine\": 110,\n                                                \"startColumn\": 15\n                                            }\n                                        },\n                                        \"logicalLocations\": [\n                                            {\n                                                \"fullyQualifiedName\": \"collections::list::add_core\"\n                                            }\n                                        ]\n                                    },\n                                    \"module\": \"platform\",\n                                    \"threadId\": 52,\n                                    \"parameters\": [\n                                        \"null\",\n                                        \"0\",\n                                        \"14\"\n                                    ]\n                                }\n                            ],\n                            \"message\": {\n                                \"text\": \"Call stack resulting from usage of uninitialized variable.\"\n                            }\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/stack/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/stack.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/stack.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Location;\nuse Bartlett\\Sarif\\Definition\\LogicalLocation;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\PhysicalLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Stack;\nuse Bartlett\\Sarif\\Definition\\StackFrame;\n\n$frame = new StackFrame();\n\n$location = new Location();\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('collections/list.h');\n$artifactLocation-&gt;setUriBaseId('SRCROOT');\n$physicalLocation = new PhysicalLocation($artifactLocation);\n$physicalLocation-&gt;setRegion(new Region(110, 15));\n$location-&gt;setPhysicalLocation($physicalLocation);\n$logicalLocation = new LogicalLocation();\n$logicalLocation-&gt;setFullyQualifiedName('collections::list::add_core');\n$location-&gt;addLogicalLocations([$logicalLocation]);\n$frame-&gt;setLocation($location);\n$frame-&gt;setModule('platform');\n$frame-&gt;setThreadId(52);\n$frame-&gt;addParameters(['null', '0', '14']);\n\n$stack = new Stack([$frame]);\n$stack-&gt;setMessage(new Message('Call stack resulting from usage of uninitialized variable.'));\n</code></pre>"},{"location":"reference/stackFrame/","title":"stackFrame","text":""},{"location":"reference/stackFrame/#stackframe-object","title":"stackFrame object","text":"<p>A <code>stackFrame</code> object describes a single stack frame within a call stack.</p> <p></p>"},{"location":"reference/stackFrame/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"SarifSamples\",\n                    \"version\": \"1.0\",\n                    \"informationUri\": \"https://github.com/microsoft/sarif-tutorials/\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Uninitialized variable.\"\n                    },\n                    \"ruleId\": \"TUT1001\",\n                    \"locations\": [\n                        {\n                            \"physicalLocation\": {\n                                \"artifactLocation\": {\n                                    \"uri\": \"collections/list.h\",\n                                    \"uriBaseId\": \"SRCROOT\"\n                                },\n                                \"region\": {\n                                    \"startLine\": 15\n                                }\n                            },\n                            \"logicalLocations\": [\n                                {\n                                    \"fullyQualifiedName\": \"collections::list::add\"\n                                }\n                            ]\n                        }\n                    ],\n                    \"stacks\": [\n                        {\n                            \"frames\": [\n                                {\n                                    \"location\": {\n                                        \"physicalLocation\": {\n                                            \"artifactLocation\": {\n                                                \"uri\": \"collections/list.h\",\n                                                \"uriBaseId\": \"SRCROOT\"\n                                            },\n                                            \"region\": {\n                                                \"startLine\": 110,\n                                                \"startColumn\": 15\n                                            }\n                                        },\n                                        \"logicalLocations\": [\n                                            {\n                                                \"fullyQualifiedName\": \"collections::list::add_core\"\n                                            }\n                                        ]\n                                    },\n                                    \"module\": \"platform\",\n                                    \"threadId\": 52,\n                                    \"parameters\": [\n                                        \"null\",\n                                        \"0\",\n                                        \"14\"\n                                    ]\n                                }\n                            ],\n                            \"message\": {\n                                \"text\": \"Call stack resulting from usage of uninitialized variable.\"\n                            }\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/stackFrame/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/stack.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/stack.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Location;\nuse Bartlett\\Sarif\\Definition\\LogicalLocation;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\PhysicalLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\Stack;\nuse Bartlett\\Sarif\\Definition\\StackFrame;\n\n$frame = new StackFrame();\n\n$location = new Location();\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('collections/list.h');\n$artifactLocation-&gt;setUriBaseId('SRCROOT');\n$physicalLocation = new PhysicalLocation($artifactLocation);\n$physicalLocation-&gt;setRegion(new Region(110, 15));\n$location-&gt;setPhysicalLocation($physicalLocation);\n$logicalLocation = new LogicalLocation();\n$logicalLocation-&gt;setFullyQualifiedName('collections::list::add_core');\n$location-&gt;addLogicalLocations([$logicalLocation]);\n$frame-&gt;setLocation($location);\n$frame-&gt;setModule('platform');\n$frame-&gt;setThreadId(52);\n$frame-&gt;addParameters(['null', '0', '14']);\n\n$stack = new Stack([$frame]);\n$stack-&gt;setMessage(new Message('Call stack resulting from usage of uninitialized variable.'));\n</code></pre>"},{"location":"reference/suppression/","title":"Suppression","text":""},{"location":"reference/suppression/#suppression-object","title":"suppression object","text":"<p>A <code>suppression</code> object describes a request to suppress a result.</p> <p></p>"},{"location":"reference/suppression/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"Psalm\",\n                    \"version\": \"4.x-dev\",\n                    \"informationUri\": \"https://psalm.de\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"Request to suppress a result\"\n                    },\n                    \"suppressions\": [\n                        {\n                            \"kind\": \"inSource\",\n                            \"guid\": \"11111111-1111-1111-8888-111111111111\",\n                            \"status\": \"underReview\",\n                            \"justification\": \"result outdated\"\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/suppression/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/suppression.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/suppression.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\Result;\nuse Bartlett\\Sarif\\Definition\\Suppression;\n\n$suppression = new Suppression('inSource');\n$suppression-&gt;setGuid('11111111-1111-1111-8888-111111111111');\n$suppression-&gt;setStatus('underReview');\n$suppression-&gt;setJustification('result outdated');\n\n$result = new Result(new Message('Request to suppress a result'));\n$result-&gt;addSuppressions([$suppression]);\n</code></pre>"},{"location":"reference/threadFlow/","title":"threadFlow","text":""},{"location":"reference/threadFlow/#threadflow-object","title":"threadFlow object","text":"<p>A <code>threadFlow</code> object is a sequence of code locations that specify a possible path through a single thread of execution such as an operating system thread or a fiber.</p> <p></p>"},{"location":"reference/threadFlow/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"A result object\"\n                    },\n                    \"codeFlows\": [\n                        {\n                            \"threadFlows\": [\n                                {\n                                    \"locations\": [\n                                        {\n                                            \"location\": {\n                                                \"physicalLocation\": {\n                                                    \"artifactLocation\": {\n                                                        \"uri\": \"ui/window.c\",\n                                                        \"uriBaseId\": \"SRCROOT\"\n                                                    },\n                                                    \"region\": {\n                                                        \"startLine\": 42\n                                                    }\n                                                }\n                                            },\n                                            \"state\": {\n                                                \"x\": {\n                                                    \"text\": \"42\"\n                                                },\n                                                \"y\": {\n                                                    \"text\": \"54\"\n                                                },\n                                                \"x+y\": {\n                                                    \"text\": \"96\"\n                                                }\n                                            },\n                                            \"nestingLevel\": 0,\n                                            \"executionOrder\": 2\n                                        }\n                                    ],\n                                    \"id\": \"thread-123\",\n                                    \"message\": {\n                                        \"text\": \"A threadFlow object\"\n                                    }\n                                }\n                            ],\n                            \"message\": {\n                                \"text\": \"A codeFlow object\"\n                            }\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/threadFlow/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/codeFlow.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/codeFlow.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Location;\nuse Bartlett\\Sarif\\Definition\\Message;\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\PhysicalLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\ThreadFlow;\nuse Bartlett\\Sarif\\Definition\\ThreadFlowLocation;\n\n$threadFlowLocation = new ThreadFlowLocation();\n$location = new Location();\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('ui/window.c');\n$artifactLocation-&gt;setUriBaseId('SRCROOT');\n$physicalLocation = new PhysicalLocation($artifactLocation);\n$physicalLocation-&gt;setRegion(new Region(42));\n$location-&gt;setPhysicalLocation($physicalLocation);\n$threadFlowLocation-&gt;setLocation($location);\n$threadFlowLocation-&gt;addAdditionalProperties([\n    'x' =&gt; new MultiformatMessageString('42'),\n    'y' =&gt; new MultiformatMessageString('54'),\n    'x+y' =&gt; new MultiformatMessageString('96'),\n]);\n$threadFlowLocation-&gt;setNestingLevel(0);\n$threadFlowLocation-&gt;setExecutionOrder(2);\n\n$threadFlow = new ThreadFlow([$threadFlowLocation]);\n$threadFlow-&gt;setId('thread-123');\n$threadFlow-&gt;setMessage(new Message('A threadFlow object'));\n</code></pre>"},{"location":"reference/threadFlowLocation/","title":"threadFlowLocation","text":""},{"location":"reference/threadFlowLocation/#threadflowlocation-object","title":"threadFlowLocation object","text":"<p>A <code>threadFlowLocation</code> object represents a location visited by an analysis tool in the course of simulating or monitoring the execution of a program.</p> <p></p>"},{"location":"reference/threadFlowLocation/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"results\": [\n                {\n                    \"message\": {\n                        \"text\": \"A result object\"\n                    },\n                    \"codeFlows\": [\n                        {\n                            \"threadFlows\": [\n                                {\n                                    \"locations\": [\n                                        {\n                                            \"location\": {\n                                                \"physicalLocation\": {\n                                                    \"artifactLocation\": {\n                                                        \"uri\": \"ui/window.c\",\n                                                        \"uriBaseId\": \"SRCROOT\"\n                                                    },\n                                                    \"region\": {\n                                                        \"startLine\": 42\n                                                    }\n                                                }\n                                            },\n                                            \"state\": {\n                                                \"x\": {\n                                                    \"text\": \"42\"\n                                                },\n                                                \"y\": {\n                                                    \"text\": \"54\"\n                                                },\n                                                \"x+y\": {\n                                                    \"text\": \"96\"\n                                                }\n                                            },\n                                            \"nestingLevel\": 0,\n                                            \"executionOrder\": 2\n                                        }\n                                    ],\n                                    \"id\": \"thread-123\",\n                                    \"message\": {\n                                        \"text\": \"A threadFlow object\"\n                                    }\n                                }\n                            ],\n                            \"message\": {\n                                \"text\": \"A codeFlow object\"\n                            }\n                        }\n                    ]\n                }\n            ]\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/threadFlowLocation/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/codeFlow.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/codeFlow.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Location;\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\PhysicalLocation;\nuse Bartlett\\Sarif\\Definition\\Region;\nuse Bartlett\\Sarif\\Definition\\ThreadFlowLocation;\n\n$threadFlowLocation = new ThreadFlowLocation();\n$location = new Location();\n$artifactLocation = new ArtifactLocation();\n$artifactLocation-&gt;setUri('ui/window.c');\n$artifactLocation-&gt;setUriBaseId('SRCROOT');\n$physicalLocation = new PhysicalLocation($artifactLocation);\n$physicalLocation-&gt;setRegion(new Region(42));\n$location-&gt;setPhysicalLocation($physicalLocation);\n$threadFlowLocation-&gt;setLocation($location);\n$threadFlowLocation-&gt;addAdditionalProperties([\n    'x' =&gt; new MultiformatMessageString('42'),\n    'y' =&gt; new MultiformatMessageString('54'),\n    'x+y' =&gt; new MultiformatMessageString('96'),\n]);\n$threadFlowLocation-&gt;setNestingLevel(0);\n$threadFlowLocation-&gt;setExecutionOrder(2);\n</code></pre>"},{"location":"reference/tool/","title":"Tool","text":""},{"location":"reference/tool/#tool-object","title":"tool object","text":"<p>A <code>tool</code> object describes the analysis tool or converter that was run.</p> <p></p>"},{"location":"reference/tool/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"fullName\": \"CodeScanner 1.1, Developer Preview (en-US)\",\n                    \"version\": \"1.1.2b12\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                },\n                \"extensions\": [\n                    {\n                        \"name\": \"CodeScanner Security Rules\",\n                        \"version\": \"3.1\"\n                    }\n                ]\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/tool/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/tool.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/tool.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Tool;\nuse Bartlett\\Sarif\\Definition\\ToolComponent;\n\n$driver = new ToolComponent('CodeScanner');\n\n$tool = new Tool($driver);\n</code></pre>"},{"location":"reference/toolComponentReference/","title":"toolComponentReference","text":""},{"location":"reference/toolComponentReference/#toolcomponentreference-object","title":"toolComponentReference object","text":"<p>A <code>toolComponentReference</code> object identifies a particular <code>toolComponent</code> object, either theTool.driver or an element of theTool.extensions. We refer to the identified toolComponent object as theComponent.</p> <p></p>"},{"location":"reference/toolComponentReference/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"rules\": [\n                        {\n                            \"id\": \"CA1000\",\n                            \"relationships\": [\n                                {\n                                    \"target\": {\n                                        \"index\": 0,\n                                        \"id\": \"327\",\n                                        \"guid\": \"33333333-0000-1111-8888-111111111111\",\n                                        \"toolComponent\": {\n                                            \"name\": \"CWE\",\n                                            \"guid\": \"33333333-0000-1111-8888-000000000000\"\n                                        }\n                                    },\n                                    \"kinds\": [\n                                        \"superset\"\n                                    ]\n                                }\n                            ]\n                        }\n                    ]\n                }\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/toolComponentReference/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/reportingDescriptorRelationship.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/reportingDescriptorRelationship.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptor;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptorReference;\nuse Bartlett\\Sarif\\Definition\\ReportingDescriptorRelationship;\nuse Bartlett\\Sarif\\Definition\\Run;\nuse Bartlett\\Sarif\\Definition\\Tool;\nuse Bartlett\\Sarif\\Definition\\ToolComponent;\nuse Bartlett\\Sarif\\Definition\\ToolComponentReference;\nuse Bartlett\\Sarif\\SarifLog;\n\n$target = new ReportingDescriptorReference(0, '327', '33333333-0000-1111-8888-111111111111');\n$toolComponent = new ToolComponentReference();\n$toolComponent-&gt;setName('CWE');\n$toolComponent-&gt;setGuid('33333333-0000-1111-8888-000000000000');\n$target-&gt;setToolComponent($toolComponent);\n</code></pre>"},{"location":"reference/translationMetadata/","title":"translationMetadata","text":""},{"location":"reference/translationMetadata/#translationmetadata-object","title":"translationMetadata object","text":"<p>A <code>translationMetadata</code> object defines locations of special significance to SARIF consumers.</p> <p></p>"},{"location":"reference/translationMetadata/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"(fr-FR translation)\",\n                    \"fullName\": \"(fr-FR translation of translated component\\u2019s full name)\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\",\n                    \"language\": \"fr-FR\",\n                    \"translationMetadata\": {\n                        \"name\": \"CodeScanner translation for fr-FR\",\n                        \"fullName\": \"CodeScanner translation for fr-FR by Example Corp.\",\n                        \"shortDescription\": {\n                            \"text\": \"A good translation\"\n                        },\n                        \"fullDescription\": {\n                            \"text\": \"A good translation performed by native en-US speakers.\"\n                        }\n                    }\n                }\n            },\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/translationMetadata/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/translationMetadata.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/translationMetadata.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\MultiformatMessageString;\nuse Bartlett\\Sarif\\Definition\\ToolComponent;\nuse Bartlett\\Sarif\\Definition\\TranslationMetadata;\n\n$driver = new ToolComponent('CodeScanner');\n\n$translationMetadata = new TranslationMetadata('CodeScanner translation for fr-FR');\n$translationMetadata-&gt;setFullName('CodeScanner translation for fr-FR by Example Corp.');\n$translationMetadata-&gt;setShortDescription(\n    new MultiformatMessageString('A good translation')\n);\n$translationMetadata-&gt;setFullDescription(\n    new MultiformatMessageString('A good translation performed by native en-US speakers.')\n);\n$driver-&gt;setTranslationMetadata($translationMetadata);\n\n$driver-&gt;setName('(fr-FR translation)');\n$driver-&gt;setFullName('(fr-FR translation of translated component\u2019s full name)');\n</code></pre>"},{"location":"reference/versionControlDetails/","title":"versionControlDetails","text":""},{"location":"reference/versionControlDetails/#versioncontroldetails-object","title":"versionControlDetails object","text":"<p>A <code>versionControlDetails</code> object specifies the information necessary to retrieve from a version control system (VCS) the correct revision of the files that were scanned during the run.</p> <p></p>"},{"location":"reference/versionControlDetails/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"AndroidStudio\",\n                    \"semanticVersion\": \"1.0.0-beta.1\",\n                    \"informationUri\": \"https://android-studion.dev\"\n                }\n            },\n            \"versionControlProvenance\": [\n                {\n                    \"repositoryUri\": \"https://github.com/example-corp/package\",\n                    \"revisionId\": \"b87c4e9\",\n                    \"mappedTo\": {\n                        \"uriBaseId\": \"PACKAGE_ROOT\"\n                    }\n                },\n                {\n                    \"repositoryUri\": \"https://github.com/example-corp/plugin1\",\n                    \"revisionId\": \"cafdac7\",\n                    \"mappedTo\": {\n                        \"uri\": \"plugin1\",\n                        \"uriBaseId\": \"PACKAGE_ROOT\"\n                    }\n                },\n                {\n                    \"repositoryUri\": \"https://github.com/example-corp/plugin2\",\n                    \"revisionId\": \"d0dc2c0\",\n                    \"mappedTo\": {\n                        \"uri\": \"plugin2\",\n                        \"uriBaseId\": \"PACKAGE_ROOT\"\n                    }\n                }\n            ],\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/versionControlDetails/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/versionControlDetails.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/versionControlDetails.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\ArtifactLocation;\nuse Bartlett\\Sarif\\Definition\\Run;\nuse Bartlett\\Sarif\\Definition\\Tool;\nuse Bartlett\\Sarif\\Definition\\VersionControlDetails;\n\n$tool = new Tool($driver);\n\n$package = new VersionControlDetails('https://github.com/example-corp/package');\n$package-&gt;setRevisionId('b87c4e9');\n$packageMappedTo = new ArtifactLocation();\n$packageMappedTo-&gt;setUriBaseId('PACKAGE_ROOT');\n$package-&gt;setMappedTo($packageMappedTo);\n\n$plugin1 = new VersionControlDetails('https://github.com/example-corp/plugin1');\n$plugin1-&gt;setRevisionId('cafdac7');\n$plugin1MappedTo = new ArtifactLocation();\n$plugin1MappedTo-&gt;setUriBaseId('PACKAGE_ROOT');\n$plugin1MappedTo-&gt;setUri('plugin1');\n$plugin1-&gt;setMappedTo($plugin1MappedTo);\n\n$plugin2 = new VersionControlDetails('https://github.com/example-corp/plugin2');\n$plugin2-&gt;setRevisionId('d0dc2c0');\n$plugin2MappedTo = new ArtifactLocation();\n$plugin2MappedTo-&gt;setUriBaseId('PACKAGE_ROOT');\n$plugin2MappedTo-&gt;setUri('plugin2');\n$plugin2-&gt;setMappedTo($plugin2MappedTo);\n\n$run = new Run($tool);\n$run-&gt;addVersionControlDetails([$package, $plugin1, $plugin2]);\n</code></pre>"},{"location":"reference/webRequest/","title":"webRequest","text":""},{"location":"reference/webRequest/#webrequest-object","title":"webRequest object","text":"<p>A <code>webRequest</code> object describes an HTTP request (RFC7230).</p> <p></p>"},{"location":"reference/webRequest/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"webRequests\": [\n                {\n                    \"protocol\": \"http\",\n                    \"version\": \"1.1\",\n                    \"target\": \"httpbin.org/bearer\",\n                    \"method\": \"GET\",\n                    \"headers\": {\n                        \"accept\": \"application/json\",\n                        \"Authorization\": \"none\"\n                    }\n                }\n            ],\n            \"webResponses\": [\n                {\n                    \"protocol\": \"http\",\n                    \"version\": \"1.1\",\n                    \"statusCode\": 401,\n                    \"reasonPhrase\": \"Error: UNAUTHORIZED\",\n                    \"headers\": {\n                        \"access-control-allow-credentials\": \"true\",\n                        \"access-control-allow-origin\": \"*\",\n                        \"connection\": \"keep-alive\",\n                        \"content-length\": \"0\",\n                        \"content-type\": \"text/html; charset=utf-8\",\n                        \"date\": \"Sun, 07 Nov 2021 08:59:53 GMT\",\n                        \"server\": \"gunicorn/19.9.0\",\n                        \"www-authenticate\": \"Bearer\"\n                    }\n                }\n            ],\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/webRequest/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/webRequest.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/webRequest.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Run;\nuse Bartlett\\Sarif\\Definition\\Tool;\nuse Bartlett\\Sarif\\Definition\\WebRequest;\n\n$tool = new Tool($driver);\n\n$webRequest = new WebRequest();\n$webRequest-&gt;setProtocol('http');\n$webRequest-&gt;setVersion('1.1');\n$webRequest-&gt;setMethod('GET');\n$webRequest-&gt;setTarget('httpbin.org/bearer');\n$webRequest-&gt;addAdditionalPropertiesHeaders([\n    'accept' =&gt; 'application/json',\n    'Authorization' =&gt; 'none',\n]);\n\n$run = new Run($tool);\n$run-&gt;addWebRequests([$webRequest]);\n</code></pre>"},{"location":"reference/webResponse/","title":"webResponse","text":""},{"location":"reference/webResponse/#webresponse-object","title":"webResponse object","text":"<p>A <code>webResponse</code> object describes the response to an HTTP request (RFC7230)</p> <p></p>"},{"location":"reference/webResponse/#example","title":"Example","text":"<pre><code>{\n    \"$schema\": \"https://json.schemastore.org/sarif-2.1.0.json\",\n    \"version\": \"2.1.0\",\n    \"runs\": [\n        {\n            \"tool\": {\n                \"driver\": {\n                    \"name\": \"CodeScanner\",\n                    \"semanticVersion\": \"1.1.2-beta.12\",\n                    \"informationUri\": \"https://codeScanner.dev\"\n                }\n            },\n            \"webRequests\": [\n                {\n                    \"protocol\": \"http\",\n                    \"version\": \"1.1\",\n                    \"target\": \"httpbin.org/bearer\",\n                    \"method\": \"GET\",\n                    \"headers\": {\n                        \"accept\": \"application/json\",\n                        \"Authorization\": \"none\"\n                    }\n                }\n            ],\n            \"webResponses\": [\n                {\n                    \"protocol\": \"http\",\n                    \"version\": \"1.1\",\n                    \"statusCode\": 401,\n                    \"reasonPhrase\": \"Error: UNAUTHORIZED\",\n                    \"headers\": {\n                        \"access-control-allow-credentials\": \"true\",\n                        \"access-control-allow-origin\": \"*\",\n                        \"connection\": \"keep-alive\",\n                        \"content-length\": \"0\",\n                        \"content-type\": \"text/html; charset=utf-8\",\n                        \"date\": \"Sun, 07 Nov 2021 08:59:53 GMT\",\n                        \"server\": \"gunicorn/19.9.0\",\n                        \"www-authenticate\": \"Bearer\"\n                    }\n                }\n            ],\n            \"results\": []\n        }\n    ]\n}\n</code></pre>"},{"location":"reference/webResponse/#how-to-generate","title":"How to generate","text":"<p>See full <code>examples/webRequest.php</code> script into repository.</p> <p>[!NOTE] Since release 1.5.0, you may use fluent builders API as alternative. See full <code>examples/builder/webRequest.php</code> script into repository.</p> <pre><code>&lt;?php declare(strict_types=1);\n\nuse Bartlett\\Sarif\\Definition\\Run;\nuse Bartlett\\Sarif\\Definition\\Tool;\nuse Bartlett\\Sarif\\Definition\\WebResponse;\n\n$tool = new Tool($driver);\n\n$webResponse = new WebResponse();\n$webResponse-&gt;setProtocol('http');\n$webResponse-&gt;setVersion('1.1');\n$webResponse-&gt;setStatusCode(401);\n$webResponse-&gt;setReasonPhrase('Error: UNAUTHORIZED');\n$webResponse-&gt;addAdditionalProperties([\n    'access-control-allow-credentials' =&gt; 'true',\n    'access-control-allow-origin' =&gt; '*',\n    'connection' =&gt; 'keep-alive',\n    'content-length' =&gt; '0',\n    'content-type' =&gt; 'text/html; charset=utf-8',\n    'date' =&gt; 'Sun, 07 Nov 2021 08:59:53 GMT',\n    'server' =&gt; 'gunicorn/19.9.0',\n    'www-authenticate' =&gt; 'Bearer',\n]);\n\n$run = new Run($tool);\n$run-&gt;addWebResponses([$webResponse]);\n</code></pre>"}]}
\ No newline at end of file
diff --git a/2.0/sitemap.xml b/2.0/sitemap.xml
index edf2935..f8df564 100644
--- a/2.0/sitemap.xml
+++ b/2.0/sitemap.xml
@@ -15,11 +15,6 @@
          <lastmod>2024-07-01</lastmod>
          <changefreq>daily</changefreq>
     </url>
-    <url>
-         <loc>https://llaville.github.io/sarif-php-sdk/github-code-scanning/</loc>
-         <lastmod>2024-07-01</lastmod>
-         <changefreq>daily</changefreq>
-    </url>
     <url>
          <loc>https://llaville.github.io/sarif-php-sdk/reference/</loc>
          <lastmod>2024-07-01</lastmod>
diff --git a/2.0/sitemap.xml.gz b/2.0/sitemap.xml.gz
index c263b8f001338f4a5992802cfad4dba3a6d2c3aa..e805152919298aebf7c418031a1bd0ae2ee92069 100644
GIT binary patch
delta 569
zcmV-90>=H{1knVLBY%n0V!%F-xENC8)L}!={QyR$ZK1NHigZ5y{bVOta~O6RFyQqi
zvA{?V8G?KXtsYOkn;kfb4SrqRFP6oOy$QAT?Yj8+vYme_9;>_6kesm2vay$S(W%BS
zWqCXv7h;urin0i)EyZ;CMat`9xm<iMs=HZ!#tkmtrf21Xsei^@ByZy!9jtS_Xsvd`
zeqlo?lx#DPU7Sn(TCU2`{Px!*+K0M&SU!B1FF($g_u1sSc4KBb@+~)s->RCdJFm){
zl?zt+o9mwltrw+ir8$ZKxckAnniBwN;)YXBNQPpix=t*D#hlbOWE2v5Go6Hq9=x&#
z3%e?ru1CYpZGVloE*!z2ePi1pO}*uN?$pWFjOM{rU_fDW4OUS`;Fm;WtjS@KpA1KZ
zOOTUt^5lM`5II+K7G(VM);iun%B{b8g7v2~_5{V-CW;*%F=m;x{tyho)k$}S-tlEX
zmd-{n2U=^$JtGFc&vPh&2^k-1G~hhTS-|Xw-C1B$JAbj!e1>B%>gdQY-0+;aLl(Kd
z-P{hOm@YiAm}H}dgwBsC*#GDVs5nS0gHu4{JS`pA6I|{L9*y_wprN0#`-wH5i#3u?
z>(8OZf{twLyRHF?xRQCrBi<(Jv1*A7F^(5?XhKH2#8kswWxQiU&Knwng9F}#J_etM
z4NRq|i88!gl;OABJ8M#c;=f*ejhDPBIK=jU<o%A{1{TG`mYn+X9}<505Z3A!`WzV#
HPbB~Vw9+6Y

delta 583
zcmV-N0=WIr1m6UZBY(EjV!%F-q!?1<)L}!={QyR0Y@xEGigZ5y{bVOta~O6RFyQqi
z386?28HRcZE*?+4n;kfb4SreNSMy@V-h{^bc3J#<*_5A($JO0pNKRO1d9jye(W%BS
zb$vV@E3wKwMX5q+YcXB^AobN)&#TYH>TZ^waf8dd=~=j7R)6CzlDBb=4%RuYTC3f#
zt8A!+lHHfFi={NL^`ah^-+r4!`_QZ&<_{mr`Nwj8pO;*1H_J>%zU6)5w^c*dofq|u
z<$_iJ=K3c>>qRNA(i}wq+}&VZ!wG=&VlQ(-aw&$q&v^-eop{eF|Bo1om6|582o`fv
zyC<WN(Cg_WOn>y?l|5M4RmpTc8unQHHZB~&p#9#qLz=F{?^$3Z+c263S6u{!%?(&Z
z8G&CCjj<+&MSe0I6)r(e%E^=akwWBL%~_D~&l~G_3n{n$>Iv45vbQHF-ZoL}@Q5+X
zr1ghj2(C`LEA*BxeZ6!xf;rGyL+%+d_<im}2~5cN(0`x-=U&bNW=HJK0-M^2jpj2P
zgHcCEhT)p$%pJ1G_3iq$A;omziNz!vH6(O?Ou_y~M?l3vVi}wQBIj=Dz@Ff8XYgpe
zUk45Sl-*CP`CP1)bh1AOtZ9)%HuhcDfJI!%yy6jW67^WMM1~m0K^>Zq(JnDHaHEWO
zY{-5?LqKqF!0XV*;B&KqsT4Jlmy0s|mhaAnl%V*pgRgPOn}S2U{*S!d^4q|oc-WFt
VU;abFPcOo{`UUi3o~#BY005f-E(ZVr