Skip to content

Commit

Permalink
[NO-TICKET]: fix Update Finding State param docs
Browse files Browse the repository at this point in the history
Signed-off-by: Akos Kitta <akos.kitta@cobalt.io>
  • Loading branch information
kittaakos committed Mar 27, 2024
1 parent 6b6c073 commit bc7ec80
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions versions/v2/content/update-finding-state.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,9 +36,9 @@ This endpoint retrieves the current state of a finding as well as possible next

### URL Parameters

| Parameter | Description |
|-------------------|--------------------------------------------------------------|
| `YOUR-FINDING-ID` | A unique ID representing the organization. Starts with `vl_` |
| Parameter | Description |
|-------------------|---------------------------------------------------------|
| `YOUR-FINDING-ID` | A unique ID representing the finding. Starts with `vl_` |

### Response Fields

Expand All @@ -62,7 +62,7 @@ This endpoint retrieves the current state of a finding as well as possible next
```sh
curl -X PATCH "https://api.us.cobalt.io/findings/YOUR-FINDING-ID" \
-H "Accept: application/vnd.cobalt.v2+json" \
-H 'Content-Type: application/vnd.cobalt.v2+json' \
-H "Content-Type: application/vnd.cobalt.v2+json" \
-H "Idempotency-Key: A-UNIQUE-IDENTIFIER-TO-PREVENT-UNINTENTIONAL-DUPLICATION" \
-H "Authorization: Bearer YOUR-PERSONAL-API-TOKEN" \
-H "X-Org-Token: YOUR-V2-ORGANIZATION-TOKEN" \
Expand All @@ -79,12 +79,12 @@ This endpoint updates the current state of a finding.

### URL Parameters

| Parameter | Description |
|-------------------|--------------------------------------------------------------|
| `YOUR-FINDING-ID` | A unique ID representing the organization. Starts with `vl_` |
| Parameter | Description |
|-------------------|---------------------------------------------------------|
| `YOUR-FINDING-ID` | A unique ID representing the finding. Starts with `vl_` |

### Body

| Field | Description |
|---------|------------------------------------------------------------------------------|
| `state` | The desired next state of the finding. Should be one of the possible states. |
| `state` | The desired next state of the finding. Should be one of the possible [states](./#states). |

0 comments on commit bc7ec80

Please sign in to comment.