elastic / elastic/docs-content

Really hard to find the APIs you are looking for in anomaly detection section

Open
#1,231 5 comments 0 reactions 0 assignees View on GitHub
api-feedback documentation Team:Platform
Dominant language
No language data
Stars
47
Forks
261
Avg merge
3d 21h
Merged PRs (30d)
141

Description

https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-ml-anomaly

It's very difficult to find the APIs you need

1. The list is long and full of repeated items (see elastic/elasticsearch-specification#4277 )
2. The description is longer text and therefore harder to scan. e.g. `Delete forecast` has become `Delete forecast from a job` and `Get records` has become `Get anomaly records for an anomaly detection job`
3. The ordering has changed.. but I can't tell how its meant to be ordered. Before it was alphabetical (add, create, delete, get, update). Now its all over the place. Its sometimes alphabetical. And sometimes grouped (although the groups are not always applied propery).
4. The most common APIs (Get jobs, Create jobs) are almost impossible to pick out

cc @valeriy42

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.