Add Kruize local API documentation #1174
Conversation
shreyabiradar07
added
local_monitoring
kruize-local
shreyabiradar07
force-pushed
the
kruize_local_api_doc
branch
from
8f71cac
to
d84803b
Compare
rbadagandi1
added
remote_monitoring
and removed
local_monitoring
kruize-local
rbadagandi1
added
kruize-local
There was a problem hiding this comment.
@shreyabiradar07 - Can you check the formatting, listDatasources API example response has all the remaining content within it (including other APIs)
fixed the formatting issue |
|
|
||
| `curl -H 'Accept: application/json' "http://<URL>:<PORT>/dsmetadata?datasource=<datasource_name>&cluster_name=<cluster_name>&verbose=true"` | ||
|
|
||
| Returns the container-level metadata of all the namespaces present in the specified cluster name and datasource |
There was a problem hiding this comment.
Please mention the difference with and without verbose more clearly
There was a problem hiding this comment.
Updated description for verbose parameter
design/KruizeLocalAPI.md
Outdated
|
|
||
| example | ||
|
|
||
| `curl --location --request POST 'http://127.0.0.1:8080/generateRecommendations?interval_end_time=2023-01-02T00:15:00.000Z&experiment_name=temp_1'` |
There was a problem hiding this comment.
Better to provide an example without the interval_end_time. Also use http://<URL>:<PORT>/ insead of http://127.0.0.1:8080
There was a problem hiding this comment.
Please explain what is returned when interval_end_time is not specified
There was a problem hiding this comment.
Included an example for case where interval_end_time is not specified
This PR has the documentation changes for Kruize Local Monitoring usecase, with following APIs documented