Add false-positive information in the api response

doc/api/vulnerability_findings.md

@@ -74,77 +74,66 @@ Example response:
 [
   {
     "id": null,
-    "report_type": "dependency_scanning",
-    "name": "Authentication bypass via incorrect DOM traversal and canonicalization in saml2-js",
-    "severity": "unknown",
-    "confidence": "undefined",
+    "report_type": "sast",
+    "name": "Possible command injection",
+    "severity": "high",
+    "confidence": "high",
     "scanner": {
-      "external_id": "gemnasium",
-      "name": "Gemnasium"
+      "external_id": "brakeman",
+      "name": "Brakeman",
+      "vendor": "GitLab"
     },
     "identifiers": [
       {
-        "external_type": "gemnasium",
-        "external_id": "9952e574-7b5b-46fa-a270-aeb694198a98",
-        "name": "Gemnasium-9952e574-7b5b-46fa-a270-aeb694198a98",
-        "url": "https://deps.sec.gitlab.com/packages/npm/saml2-js/versions/1.5.0/advisories"
-      },
-      {
-        "external_type": "cve",
-        "external_id": "CVE-2017-11429",
-        "name": "CVE-2017-11429",
-        "url": "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2017-11429"
+        "external_type": "brakeman_warning_code",
+        "external_id": "14",
+        "name": "Brakeman Warning Code 14",
+        "url": "https://brakemanscanner.org/docs/warning_types/command_injection/"
       }
     ],
-    "project_fingerprint": "fa6f5b6c5d240b834ac5e901dc69f9484cef89ec",
-    "uuid": "31f483bc-bfc0-586d-9b92-f1015c4535b8",
-    "create_vulnerability_feedback_issue_path": "/tests/yarn-remediation-test/vulnerability_feedback",
-    "create_vulnerability_feedback_merge_request_path": "/tests/yarn-remediation-test/vulnerability_feedback",
-    "create_vulnerability_feedback_dismissal_path": "/tests/yarn-remediation-test/vulnerability_feedback",
+    "project_fingerprint": "ac218b1770af030cfeef967752ab803c55afb36d",
+    "uuid": "ad5e3be3-a193-55f5-a200-bc12865fb09c",
+    "create_jira_issue_url": null,
+    "false_positive": true,
+    "create_vulnerability_feedback_issue_path": "/root/test-false-positive/-/vulnerability_feedback",
+    "create_vulnerability_feedback_merge_request_path": "/root/test-false-positive/-/vulnerability_feedback",
+    "create_vulnerability_feedback_dismissal_path": "/root/test-false-positive/-/vulnerability_feedback",
     "project": {
-      "id": 31,
-      "name": "yarn-remediation-test",
-      "full_path": "/tests/yarn-remediation-test",
-      "full_name": "tests / yarn-remediation-test"
+      "id": 2,
+      "name": "Test False Positive",
+      "full_path": "/root/test-false-positive",
+      "full_name": "Administrator / Test False Positive"
     },
     "dismissal_feedback": null,
     "issue_feedback": null,
     "merge_request_feedback": null,
-    "description": "Some XML DOM traversal and canonicalization APIs may be inconsistent in handling of comments within XML nodes. Incorrect use of these APIs by some SAML libraries results in incorrect parsing of the inner text of XML nodes such that any inner text after the comment is lost prior to cryptographically signing the SAML message. Text after the comment therefore has no impact on the signature on the SAML message.\r\n\r\nA remote attacker can modify SAML content for a SAML service provider without invalidating the cryptographic signature, which may allow attackers to bypass primary authentication for the affected SAML service provider.",
-    "links": [
-      {
-        "url": "https://github.com/Clever/saml2/commit/3546cb61fd541f219abda364c5b919633609ef3d#diff-af730f9f738de1c9ad87596df3f6de84R279"
-      },
-      {
-        "url": "https://www.kb.cert.org/vuls/id/475445"
-      },
-      {
-        "url": "https://github.com/Clever/saml2/issues/127"
-      }
-    ],
+    "description": null,
+    "links": [],
     "location": {
-      "file": "yarn.lock",
-      "dependency": {
-        "package": {
-          "name": "saml2-js"
-        },
-        "version": "1.5.0"
-      }
+      "file": "app/controllers/users_controller.rb",
+      "start_line": 42,
+      "class": "UsersController",
+      "method": "list_users"
     },
-    "details": {
-      "custom_field": {
-        "name": "URLs",
-        "type": "list",
-        "items": [
-          {
-            "type": "url",
-            "href": "http://site.com/page/1"
-          }
-        ]
-      }
+    "remediations": [
+      null
+    ],
+    "solution": null,
+    "evidence": null,
+    "request": null,
+    "response": null,
+    "evidence_source": null,
+    "supporting_messages": [],
+    "assets": [],
+    "details": {},
+    "state": "detected",
+    "scan": {
+      "type": "sast",
+      "status": "success",
+      "start_time": "2021-09-02T20:55:48",
+      "end_time": "2021-09-02T20:55:48"
     },
-    "solution": "Upgrade to fixed version.\r\n",
-    "blob_path": "/tests/yarn-remediation-test/blob/cc6c4a0778460455ae5d16ca7025ca9ca1ca75ac/yarn.lock"
+    "blob_path": "/root/test-false-positive/-/blob/dfd75607752a839bbc9c7362d111effaa470fecd/app/controllers/users_controller.rb#L42"
   }
 ]
 ```