Azure / Azure/azure-rest-api-specs

[BUG] Explaination missing of what Persistent/Transient mean in ResourceHealth

Open
#32,472 4 comments 0 reactions 1 assignee Claimed by @abhayohri View on GitHub
bug customer-reported Mgmt question
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
2d 22h
Merged PRs (30d)
444

Description

### API Spec link

https://github.com/Azure/azure-rest-api-specs/blob/07da438f8dc690946b39511467744ed889434de5/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/stable/2024-02-01/ResourceHealth.json

### API Spec version

2024-02-01

### Describe the bug

Within the rest-api spec of the Resource Health there is a reasonChronicityTypes. It does list the possible values as "Persistent" and "Transient" but does not explain what those mean. From testing I would say after a state change it will remain in "Transient" state for 20 minutes, afterwards if there are no further changes it will change to "Persistent". I guess you should note that in description of the values.

### Expected behavior

actual behavior + descriptions of that those states actually mean.

### Actual behavior

```
"reasonChronicity": {
"type": "string",
"description": "Chronicity of the availability transition.",
"enum": [
"Transient",
"Persistent"
],
"x-ms-enum": {
"name": "reasonChronicityTypes",
"modelAsString": true
}
},
```

### Reproduction Steps

Read API spec, discover missing description and the strings themselves are not self-explanatory.

### Environment

_No response_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.