technical-debt-toolbox-usage.md

@@ -81,5 +81,104 @@ The entry point of the TD Toolbox of Breaking Point Tool is a RESTful web server
 |:------------:|:---------------------------------------------------------------:|:--------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
 | projectID      | The name of the project. The name should be the same as the name that given through the analysis phase.        |    Yes   | String      |
 
+**Principal Indicators**
 
+Principal indicators include metrics at artefact level. Artefact level is file or class and package level. 
 
+**Sample Request**
+
+In this example, we want to retrieve pre analysed data in artefact level for the project with ID ‘HolisunArassistance’.
+{GET} http://195.251.210.147:7070/principalIndicators/search?projectID=HolisunArassistance
+Headers: - 
+
+Authorization: -
+
+**Response**
+
+The response format is like a table (columns, rows). Includes TD in minutes, TD in currency, number of bugs, number of vulnerabilities, number of duplications, and number of code smells for the each artefact. Same output for java and c projects.
+```
+{ 
+   "principalIndicators":{ 
+      "columns":[ 
+         { 
+            "label":"Artifact",
+            "field":"name"
+         },
+         { 
+            "label":"TD-minutes",
+            "field":"tdInMinutes"
+         },
+         { 
+            "label":"TD-currency",
+            "field":"tdInCurrency"
+         },
+         { 
+            "label":"Bugs",
+            "field":"bugs"
+         },
+         { 
+            "label":"Vulnerabilities",
+            "field":"vulnerabilities"
+         },
+         { 
+            "label":"Duplications",
+            "field":"duplCode"
+         },
+         { 
+            "label":"Code Smells",
+            "field":"codeSmells"
+         }
+      ],
+      "rows":[ 
+         { 
+            "name":"com/holisun/arassistance",
+            "MtdInMinutesPC":34,
+            "tdInCurrency":26,
+            "bugs":0,
+            "vulnerabilities":0,
+            "duplCode":0,
+            "codeSmells":8
+         },
+         { 
+            "name":"com/holisun/arassistance/SplashActivity",
+            "MtdInMinutesPC":34,
+            "tdInCurrency":26,
+            "bugs":0,
+            "vulnerabilities":0,
+            "duplCode":0,
+            "codeSmells":8
+         }
+      ]
+   }
+}
+```
+
+**Principal Summary**
+
+Principal summary includes the same metrics as before but at project level.
+
+**Sample Request**
+
+In this example, we want to retrieve pre analysed data in project level for the project with ID ‘HolisunArassistance’.
+{GET} http://195.251.210.147:7070/principalSummary/search?projectID=HolisunArassistance
+
+Headers: - 
+
+Authorization: -
+
+**Response**
+The response includes TD in minutes, TD in currency, number of bugs, number of vulnerabilities, number of duplications, and number of code smells at project level. Same output for java and c projects.
+```
+{ 
+   "principalSummary":{ 
+      "name":"Holisun Arassistance",
+      "tdInMinutes":1364,
+      "tdInCurrency":1043,
+      "bugs":0,
+      "vulnerabilities":13,
+      "duplCode":30,
+      "codeSmells":191
+   }
+}
+```
+### TD Interest