github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-06-28 17:34:17 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Fixes the description of 'affected_resources' in health API documentation (#111833)

Browse source 
* Fixed the description of 'affected_resources' in health API documentation

* Update docs/reference/health/health.asciidoc

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>

---------

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>
This commit is contained in:
kosabogi 2024-08-13 18:51:49 +02:00 • committed by GitHub
parent 82520a166b
commit a03affe40c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 2 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

5
docs/reference/health/health.asciidoc
View file

@ -204,9 +204,8 @@ for health status set `verbose` to `false` to disable the more expensive analysi
`help_url` field.
`affected_resources`::
(Optional, array of strings) If the root cause pertains to multiple resources in the
cluster (like indices, shards, nodes, etc...) this will hold all resources that this
diagnosis is applicable for.
(Optional, object) An object where the keys represent resource types (for example, indices, shards),
and the values are lists of the specific resources affected by the issue.
`help_url`::
(string) A link to the troubleshooting guide that'll fix the health problem.