Skip to content

Commit c2e714a

Browse files
Add ref_key to findings docs (#289)
* Add ref_key to findings docs * Update codeowners
1 parent 2523e2c commit c2e714a

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

.github/CODEOWNERS

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
# Foundations Team.
2-
* @cobalthq/foundations
1+
# Customer Team.
2+
* @cobalthq/customer-team

versions/v2/content/findings.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,7 @@ curl -X GET "https://api.us.cobalt.io/findings" \
113113
"version": "3.1"
114114
}
115115
],
116+
"ref_key":"#ExampleRef",
116117
"predecessor_id": null,
117118
"successor_id": null
118119
},
@@ -190,6 +191,7 @@ Cobalt Risk Classification (`severity`, a.k.a. `criticality`):
190191
| `type_category` | XSS, SQLi, ... (about 30 more via the Cobalt Taxonomy) |
191192
| `attachments` | A list of finding attachments. Attachment download URLs are pre-authorized and will expire after 10 minutes. |
192193
| `cvsss` | A list of associated [CVSS](https://www.first.org/cvss/) records |
194+
| `ref_key` | A user-defined field for adding unique identifiers to findings, aiding tracking and linking to external systems.
193195
| `predecessor_id` | The ID of the original finding that this finding was created from during the carry-over process. `null` if this finding was not created via the carry-over process. |
194196
| `successor_id` | The ID of the finding that was created from this finding during the carry-over process. `null` if this finding was not carried over. |
195197
| `links.ui.url` | A link to redirect an authorized user to this finding in the Cobalt web application |
@@ -275,6 +277,7 @@ curl -X GET "https://api.us.cobalt.io/findings/YOUR-FINDING-IDENTIFIER" \
275277
"version": "3.1"
276278
}
277279
],
280+
"ref_key":"#ExampleRef",
278281
"predecessor_id": null,
279282
"successor_id": null
280283
},
@@ -311,6 +314,7 @@ This endpoint retrieves a specific finding that belong to the organization speci
311314
| `type_category` | XSS, SQLi, ... (about 30 more via the Cobalt Taxonomy) |
312315
| `attachments` | A list of finding attachments. Attachment download URLs are pre-authorized and will expire after 10 minutes. |
313316
| `cvsss` | A list of associated [CVSS](https://www.first.org/cvss/) records |
317+
| `ref_key` | A user-defined field for adding unique identifiers to findings, aiding tracking and linking to external systems.
314318
| `predecessor_id` | The ID of the original finding that this finding was created from during the carry-over process. `null` if this finding was not created via the carry-over process. |
315319
| `successor_id` | The ID of the finding that was created from this finding during the carry-over process. `null` if this finding was not carried over. |
316320
| `url` | The links.ui.url will redirect an authorized user to this finding in the Cobalt platform |

0 commit comments

Comments
 (0)