Skip to content

Commit

Permalink
AI proof-reading changes
Browse files Browse the repository at this point in the history
  • Loading branch information
grayson-cobalt committed Dec 29, 2023
1 parent 46bf784 commit f57f3b7
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions versions/v2/content/findings.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,12 +159,14 @@ Cobalt Risk Classification (`severity`, a.k.a. `criticality`):

### Image Attachments

Several finding fields support image attachments. By default, these attachments will be rendered in our response JSON as markdown. Example: `![screenshot.png](https://api.us.cobalt.io/v1/attachments/att_xxxxxxx/preview)`.
This format is not useful for users that want to programmatically download the attachments and associate them to a certain position in the finding response.
For this use case, we support a `token` format which will render the attachment as a token that can be used to download the attachment. Example: `<CobaltImageAttachment at_KYKDAhZPXuQ4BW23g8i9QN>`.
The token format allows users to use a technology such as RegEx to search the finding response fields for image attachments and extract the image attachment IDs. Within the example token, `at_KYKDAhZPXuQ4BW23g8i9QN` is the attachment ID.
Using the attachment ID, users can find the full attachment information by searching the `attachments` array in the finding response for an attachment object with a matching ID.
The attachment object contains a `download_url` field that can be used to download the attachment.
Several finding response fields support image attachments. By default, these attachments are rendered in our response JSON as markdown. For example:
`![screenshot.png](https://api.us.cobalt.io/v1/attachments/att_xxxxxxx/preview)`
This format is not useful for users who want to programmatically download the attachments and associate them with a specific position in the finding response.
For this use case, we support a token format, which renders the attachment as a token that can be used to download the attachment. For example:
`<CobaltImageAttachment at_KYKDAhZPXuQ4BW23g8i9QN>`
The token format allows users to employ a technology such as RegEx to search the finding response fields for image attachments and extract the image attachment IDs. In the example token, `at_KYKDAhZPXuQ4BW23g8i9QN` is the attachment ID.
Users can use the attachment ID to locate the full attachment information by searching the `attachments` array in the finding response for an object with a matching ID.
The attachment object includes a `download_url` field that can be used to download the attachment.

### State

Expand Down

0 comments on commit f57f3b7

Please sign in to comment.