* Add script documentation.
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* Use my own example script insteady of Elastic's.
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* edditing and format changes. verified API requests and scripts. various corrections
Signed-off-by: ariamarble <armarble@amazon.com>
* made a couple of suggested changes
Signed-off-by: ariamarble <armarble@amazon.com>
* made further corrections
Signed-off-by: ariamarble <armarble@amazon.com>
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
Signed-off-by: ariamarble <armarble@amazon.com>
Co-authored-by: Steve Murphy <stevemurphy@BCSR-11413.local>
There is no mention of doc_as_upsert in OS documention, but it appears to be supported. Some examples to go along with the passing mention of scripts & especially upsert would go a long way
This also addresses #755
Signed-off-by: Alek Poteet <patrick.poteet@shipveho.com>
Signed-off-by: Alek Poteet <patrick.poteet@shipveho.com>
* add files for snapshot creation
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* Create new topics and fix existing. Modify index.md
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* Address Fanit's edits. Apply edits to other files as needed for consistenty. Create new files: get-snapshot.status.md and restore-snapshot.md.
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* Add .md file extension to get-snapshot-repository file
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* Add verify-snapshot-repository.md, renumber nav_order in other snapshot topics to place the new topic correctly.
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* Apply Fanit's edits to restore-snapsnot.md and verify-snapshot-repository.md
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* Address Fanit's edits.
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* Change 'Response fields' heading level to 3.
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
Signed-off-by: Steve Murphy <stevemurphy@BCSR-11413.local>
Co-authored-by: Steve Murphy <stevemurphy@BCSR-11413.local>
* added resource_stats object to sample responses
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Added information about log files
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Removed resource_stats from existing sample responses that lack the detailed flag
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Added example with detailed parameter
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Changed phrasing to use active voice
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Removed extra comma from sample JSON and rephrased feature description
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Replaced query string in detailed flag example with placeholder
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Small wording change
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
* Add ML node instructions
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
* Change cluster settings from ml to dynamic
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
* Quick typo fix
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
* Adjust ML docs to remove dymanic mention. Adjust CAT example to be general
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
* Add editorial feedback.
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
* Fix columns in example
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
* for cluster manager term update
Signed-off-by: alicejw <alicejw@amazon.com>
* for small fix
Signed-off-by: alicejw <alicejw@amazon.com>
* to change to
Signed-off-by: alicejw <alicejw@amazon.com>
1. Fixing all reported dead links.
2. Changing `title` value in index.md back to plural form, i.e. "Nodes APIs".
The second change fixed missing child pages. I am not saying I insist on use of plural form but if we want to change it to a singular form then we also have to change `parent` fields in all child pages to correctly refer to valid parent, otherwise all child pages and content is missing.
As for the debate of use APIs vs API (plural vs singular) I just want to point out that right now there are many other parent pages using plural form. If we want to change that then I suggest doing it in separate PR and include other relevant parent pages too.
Closes: #591
Signed-off-by: Lukáš Vlček <lukas.vlcek@aiven.io>
Additional improvements:
- The master_timeout is marked as deprecated and cluster_manager_timeout is suggested instead
- A required permissions is also documented
- The JSON example response is completed
Closes: #552
Signed-off-by: Lukáš Vlček <lukas.vlcek@aiven.io>
Alice Williams
Aria Marble
Chris Moore
Alek Poteet
STEVE MURPHY
Jeff Huss
Anil Jaiswal
Naarcha-AWS
alicejw
kolchfa-aws
Fanit Kolchina
Naarcha-AWS
Lukáš Vlček