Azure / Azure/azure-rest-api-specs

SecurityInsights API: Alert Rule Threat Intelligence defines "severity" as read-only

Open
#16,615 6 comments 0 reactions 0 assignees View on GitHub
SecurityInsights Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
3d 2h
Merged PRs (30d)
424

Description

In the [security insight alert rule API spec](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json#L4424), it defines the "severity" property as a read-only property. However, the backend service requires the `severity` to be set, otherwise, it returns:

```json
{
"error": {
"code": "BadRequest",
"message": "Required property 'severity' not found in JSON. Path 'properties', line 3, position 17."
}
}
```

This is a mismatch between the swagger spec and the service behavior. Needs either to change the spec or change the backend service implementation.

Contributor guide

Open the contributing guide

Research direction

Open specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json at line 4424 and inspect the severity definition and nearby alert-rule schema. Compare that contract with the reported create-request error; done means the published specification and backend agree on whether severity is required and writable.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.