Commit Graph

188 Commits

Author SHA1 Message Date
Hailong-am 1e274173d0
Fix cat/templates doc (#1356)
* Update cat-templates.md

* Update cat-templates.md

* Update _opensearch/rest-api/cat/cat-templates.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
2022-10-06 11:50:04 -05:00
Aria Marble 3720f1902c
Adding documentation for dangling index api (#1370)
* adding documentation for dangling index api

Signed-off-by: ariamarble <armarble@amazon.com>

* made editorial changes

Signed-off-by: ariamarble <armarble@amazon.com>

Signed-off-by: ariamarble <armarble@amazon.com>
2022-10-04 09:25:12 -07:00
Aria Marble 7d41fc58c4
Add documentation for reload_searchIanalyzer api (#1339)
* updated incorrect links

Signed-off-by: ariamarble <armarble@amazon.com>

* add documentation for reload search analyzer api

Signed-off-by: ariamarble <armarble@amazon.com>

* made suggested changes

Signed-off-by: ariamarble <armarble@amazon.com>

* made additional formatting changes

Signed-off-by: ariamarble <armarble@amazon.com>

* made editorial changes

Signed-off-by: ariamarble <armarble@amazon.com>

Signed-off-by: ariamarble <armarble@amazon.com>
2022-10-03 12:24:36 -07:00
Aria Marble 05f466d2af
Update of source parameter in documentation (#1368)
* update of source parameter in documentation

Signed-off-by: ariamarble <armarble@amazon.com>

* made suggested changes

Signed-off-by: ariamarble <armarble@amazon.com>

Signed-off-by: ariamarble <armarble@amazon.com>
2022-10-03 11:49:30 -07:00
Aria Marble c54e6c8ebb
Add rank eval documentation (#1316)
* updated incorrect links

Signed-off-by: ariamarble <armarble@amazon.com>

* adding documentation for rank eval api

Signed-off-by: ariamarble <armarble@amazon.com>

* made suggusted changes

Signed-off-by: ariamarble <armarble@amazon.com>

* quick syntaxt changes

Signed-off-by: ariamarble <armarble@amazon.com>

* editorial updates

Signed-off-by: ariamarble <armarble@amazon.com>

Signed-off-by: ariamarble <armarble@amazon.com>
2022-10-03 10:05:54 -07:00
Aria Marble 9d7592f400
Add wait_for_completion to API documentation (#1328)
* updated incorrect links

Signed-off-by: ariamarble <armarble@amazon.com>

* update with wait for completion

Signed-off-by: ariamarble <armarble@amazon.com>

* made suggested change

Signed-off-by: ariamarble <armarble@amazon.com>

* made additional changes

Signed-off-by: ariamarble <armarble@amazon.com>

Signed-off-by: ariamarble <armarble@amazon.com>
2022-09-27 17:09:07 -07:00
Alice Williams 282a26ebfe
[Bug] Fix broken cross-ref links in the docs (#1253)
* to fix broken cross-ref links

Signed-off-by: alicejw <alicejw@amazon.com>

* replace removed link

Signed-off-by: alicejw <alicejw@amazon.com>

Signed-off-by: alicejw <alicejw@amazon.com>
2022-09-16 17:07:38 -07:00
Alice Williams 63e1a65f29
Clear cache API - additional edits (#1214)
* to check in the cache API for Steve

Signed-off-by: alicejw <alicejw@amazon.com>

* for editorial review feedback modifications

Signed-off-by: alicejw <alicejw@amazon.com>

* doc review update

Signed-off-by: alicejw <alicejw@amazon.com>

Signed-off-by: alicejw <alicejw@amazon.com>
2022-09-14 16:39:00 -07:00
Alice Williams 1f54720013
to check in the cache API for Steve (#1168)
Signed-off-by: alicejw <alicejw@amazon.com>

Signed-off-by: alicejw <alicejw@amazon.com>
2022-09-13 09:38:23 -07:00
Aria Marble cc5406743e
Issue1157 - correcting links on scripts-api index page (#1158)
* updated incorrect links

Signed-off-by: ariamarble <armarble@amazon.com>

* quick correction of page links

Signed-off-by: ariamarble <armarble@amazon.com>

Signed-off-by: ariamarble <armarble@amazon.com>
2022-09-09 11:24:54 -07:00
Aria Marble 21386b05d0
script api documentation (#1094)
* 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>
2022-09-02 15:09:13 -07:00
Chris Moore c3f2b7bdf1
CCS-permissions (#1053)
Signed-off-by: cwillum <cwmmoore@amazon.com>

Signed-off-by: cwillum <cwmmoore@amazon.com>
2022-09-01 08:48:42 -07:00
Alek Poteet d417b5d85a
Add examples for bulk script & upsert updates (#783)
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>
2022-08-23 20:58:03 -05:00
STEVE MURPHY ebe1faeefd
add files for snapshot creation (#873)
* 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>
2022-08-23 11:42:19 -05:00
Chris Moore f32c849c93
Add upsert description to Update document API information (#934)
* fix#755-Update-document-upserts

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#755-Update-document-upserts

Signed-off-by: cwillum <cwmmoore@amazon.com>

* fix#755-Update-document-upserts

Signed-off-by: cwillum <cwmmoore@amazon.com>

Signed-off-by: cwillum <cwmmoore@amazon.com>
2022-08-22 13:10:29 -07:00
Jeff Huss fb227f8081
Task consumer integration (#866)
* 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>
2022-08-11 16:04:43 -04:00
Anil Jaiswal 745309b512
Add refresh param to documentation (#761)
* Add refresh param to documentation

Signed-off-by: Anil Jaiswal <er.anil.jaiswal@gmail.com>

* Update _opensearch/rest-api/document-apis/index-document.md

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Anil Jaiswal <er.anil.jaiswal@gmail.com>

Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
2022-08-03 10:26:46 -05:00
Naarcha-AWS 6336b83b14
Add ML node settings and dynamic node description (#787)
* 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>
2022-07-21 15:57:45 -05:00
Jeff Huss 9aa614c4b5
Fixed broken links in cat*.md, api.md and monitoring.md (#726)
Signed-off-by: jeffhuss <jeffhuss@amazon.com>
2022-06-27 15:09:21 -07:00
Alice Williams 8909564891
for cluster manager term update (#691)
* 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>
2022-06-20 13:53:51 -05:00
Alice Williams 1f271cf468
Merge pull request #688 from alicejw-aws/alice-bugs
query parameter usage incorrect - shown as URL parameters
2022-06-17 11:46:36 -07:00
alicejw f6b45c4437 for query parameter explanation
Signed-off-by: alicejw <alicejw@amazon.com>
2022-06-17 09:49:13 -07:00
kolchfa-aws 7f693add2b
Merge pull request #650 from opensearch-project/Fix128-cancel_after_time_interval
Added cancel_after_time_interval
2022-06-08 10:53:10 -04:00
Fanit Kolchina b26aa46562 Changed cancelled to canceled
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-06-08 10:50:04 -04:00
Fanit Kolchina cb8bfa93b7 Changed links from relative to absolute
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-06-07 17:07:34 -04:00
Fanit Kolchina 4a98b80e43 Added cancel_after_time_interval
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-06-07 12:02:54 -04:00
Naarcha-AWS 9e930a9c74
Merge pull request #635 from opensearch-project/Fix633-search-and-msearch-parameters
Changed parameter to allow_no_indices
2022-06-06 13:18:45 -05:00
Alice Williams b929ea8fb0
Merge pull request #615 from alicejw-aws/alice-bugs
update put mapping API requirements
2022-06-03 10:00:17 -07:00
Fanit Kolchina a24669fb49 Changed parameter to allow_no_indices
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-06-03 10:39:27 -04:00
kolchfa-aws 17480332d6
Merge pull request #622 from opensearch-project/Fix595-CAT-Pages-not-expandable
Makes CAT child pages expandable
2022-06-02 18:12:27 -04:00
Fanit Kolchina 36af3984e2 Changed master node to cluster manager node in the description
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-06-02 13:24:20 -04:00
Fanit Kolchina 9d7e732585 Changed master_timeout to cluster_manager_timeout
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-06-02 12:05:18 -04:00
Fanit Kolchina ac9985e914 Added master_timeout parameter to CAT segments
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-06-01 14:02:14 -04:00
Fanit Kolchina f3be4576f9 Changed CAT to cat in the left nav for cat cluster manager
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-05-31 18:02:26 -04:00
Fanit Kolchina 87195f645f Changed cat to lowercase in cat cluster manager
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-05-31 16:26:24 -04:00
Fanit Kolchina 67fd4686d5 Fix #595 - CAT pages not expandable
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-05-31 13:45:08 -04:00
Fanit Kolchina 5845828e44 “Fix#595-CAT-pages-not-expandable
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
2022-05-31 12:01:01 -04:00
alicejw 9f6febed92 for format fix
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-26 15:23:28 -07:00
alicejw 9aba0c6e00 for updates
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-26 15:20:04 -07:00
alicejw 4e6150e5ee for updates
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-26 15:06:09 -07:00
alicejw ed6f8ddd3b for doc bug https://github.com/opensearch-project/documentation-website/issues/565
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-26 14:23:25 -07:00
Naarcha-AWS 9585132bd9 Add wait_for_node parameter to cluster health
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-05-23 12:53:37 -05:00
Naarcha-AWS 219c1c37e2 Merge branch 'improve_cluster_health' of https://github.com/lukas-vlcek/documentation-website into lukas-vlcek-improve_cluster_health 2022-05-23 12:49:41 -05:00
Lukáš Vlček 98c7dd29a6 Fixing Nodes APIs issues
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>
2022-05-20 11:36:23 +02:00
Naarcha-AWS e437eaacfd
Merge branch 'main' into lukas-vlcek-add_node_APIs 2022-05-19 10:25:13 -05:00
Naarcha-AWS 6ad4d00060 Add editorial review
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-05-19 10:23:12 -05:00
Naarcha-AWS 46d7a45ba4
Merge branch 'main' into improve_cluster_health 2022-05-18 14:53:22 -05:00
alicejw 2bcfb4a1a3 fix merge conflict
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-18 11:16:11 -07:00
alicejw 2bbe6d092a resolve conflicts
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-18 11:08:41 -07:00
Naarcha-AWS 03807527eb More feedback
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-05-18 13:00:47 -05:00