Azure / Azure/azure-rest-api-specs

Better documentation for filter on ResourceHealth

Open
#10,892 1 comment 0 reactions 0 assignees View on GitHub
question Resource Health Service Attention
Dominant language
TypeSpec
Stars
3.1k
Forks
5.9k
Avg merge
3d 2h
Merged PRs (30d)
424

Description

The [link](https://github.com/Azure/azure-rest-api-specs/blob/master/specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json#L1544) which should explain filter is a link to no where. There isn't any good documentation explaining how the filtering works.

Is there a good document to follow?

Contributor guide

Open the contributing guide

Research direction

Open specification/resourcehealth/resource-manager/Microsoft.ResourceHealth/preview/2018-08-01/ResourceHealth.json around line 1544 and inspect the broken filter link and its surrounding description. Find the appropriate filtering guidance, update the link or documentation reference, and confirm that users can follow it to understand ResourceHealth filtering.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.