Commit Graph

147 Commits

Author SHA1 Message Date
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
Naarcha-AWS 6b2042745e Add feedback
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-05-18 12:54:11 -05:00
Naarcha-AWS bde449d48a Writer review
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-05-18 10:34:34 -05:00
Naarcha-AWS af4042887c Merge branch 'add_node_APIs' of https://github.com/lukas-vlcek/documentation-website into lukas-vlcek-add_node_APIs 2022-05-17 15:05:48 -05:00
alicejw 17c6c4a2a9 update old sample names to 'opensearch' instead of 'odfe
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-16 11:26:21 -07:00
Lukáš Vlček 9cbdc64ffd Document missing wait_for_nodes param in Cluster health Reference REST API
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>
2022-05-04 16:22:45 +02:00
alicejw 8a8f16e67c resolve merge conflicts
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-03 13:00:52 -07:00
Naarcha-AWS 35bfcd883d
Merge pull request #512 from opensearch-project/remove-mapping-types2.0
Remove type from all API requests and responses
2022-05-03 14:33:31 -05:00
alicejw bf36e0f481 updates per editor's review feedback
Signed-off-by: alicejw <alicejw@amazon.com>
2022-05-02 12:30:56 -07:00
alicejw 5b913181dc update create index - move info to mappings guide
Signed-off-by: alicejw <alicejw@amazon.com>
2022-04-28 15:08:35 -07:00
alicejw 930cfbc558 moved info about mappings from API Ref to top-level mapping guide
Signed-off-by: alicejw <alicejw@amazon.com>
2022-04-28 15:07:12 -07:00
alicejw 64e8e4b069 for updates to cluster manager nomenclature throughout descriptive sections
Signed-off-by: alicejw <alicejw@amazon.com>
2022-04-27 15:37:49 -07:00
alicejw 6b9a22cc79 for feedback comments
Signed-off-by: alicejw <alicejw@amazon.com>
2022-04-26 13:00:35 -07:00
Lukáš Vlček 2df0f8450b Introduce Nodes APIs
In this commit we are introducing a new section in REST API Reference for Nodes APIs.

We are adding documentation for "Nodes hot threads" and "Nodes info". Because Nodes APIs share common request parameters we also add more detailed section into parent index page (notice that the nodes-filter parameter was moved from "Cluster stats" page and was improved, and relevant links were updated).

There are more Nodes APIs that still need to be documented, this is just a good start.

We updated nav_order parameter for some pages as well.

Relevant ticket: #424

Signed-off-by: Lukáš Vlček <lukas.vlcek@aiven.io>
2022-04-22 18:40:11 +02:00
alicejw a5811c1764 for reviewer comments
Signed-off-by: alicejw <alicejw@amazon.com>
2022-04-20 13:58:27 -07:00
alicejw e669674d64 switch left nav as acronmy-only, and page with full title, then acronym
Signed-off-by: alicejw <alicejw@amazon.com>
2022-04-20 10:31:06 -07:00
alicejw af4afc2c1c for more changes to replace terms for #450
Signed-off-by: alicejw <alicejw@amazon.com>
2022-04-18 14:32:49 -07:00
alicejw 309f79df7f for terminology change from 'master' to 'cluster_manager' per issue #450 https://github.com/opensearch-project/documentation-website/issues/450
Signed-off-by: alicejw <alicejw@amazon.com>
2022-04-18 14:30:56 -07:00
Naarcha-AWS 0a24fa2992 Remove from all API requests and responses
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-04-14 12:55:17 -05:00
alicejw 32b5b0771f for additional reviewer suggestions
Signed-off-by: alicejw <alicejw@amazon.com>
2022-04-13 10:42:31 -07:00
alicejw fc278e9b98 modify left nav entry to match new topic name
Signed-off-by: alicejw <alicejw@amazon.com>
2022-04-13 10:00:21 -07:00
alicejw 0bf76386a5 to rename file to match api function
Signed-off-by: alicejw <alicejw@amazon.com>
2022-04-13 09:46:38 -07:00
alicejw 4b5b706220 for topic title and description of API function
Signed-off-by: alicejw <alicejw@amazon.com>
2022-04-13 09:44:58 -07:00
alicejw 2aba05aa0d for review comments
Signed-off-by: alicejw <alicejw@amazon.com>
2022-04-12 14:09:46 -07:00
alicejw 92658806ef to merge content and delete duplicate file - fix for issue https://github.com/opensearch-project/documentation-website/issues/485
Signed-off-by: alicejw <alicejw@amazon.com>
2022-04-11 18:17:16 -07:00
Keith Chan 1a6282c87c
Merge pull request #421 from opensearch-project/index-apis
Added some settings APIs
2022-02-23 13:57:43 -08:00
keithhc2 4c0e3b863d Added couple settings API
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-02-22 12:30:26 -08:00
Keith Chan cfd35dcd5d
Merge pull request #407 from opensearch-project/index-apis
Added clusters stats API
2022-02-11 16:43:04 -08:00
keithhc2 6f4542b3a4 Added clusters stats API
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-02-11 14:38:12 -08:00
Naarcha-AWS ba554dcbc1
Merge pull request #392 from opensearch-project/add-ingest-api
Add Ingest API to reference
2022-02-08 11:29:25 -06:00
Naarcha-AWS 97ad7b9503 Final typo fix
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-02-07 13:22:55 -06:00
Naarcha-AWS 0b73c7bdb6 Address Keith's feedback.
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-02-07 12:49:43 -06:00
Naarcha-AWS d5ef881c56 Fix remaining typos
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-02-04 12:02:11 -06:00
Naarcha-AWS 406db04cc2 Fix final typo.
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-02-04 11:45:12 -06:00
Naarcha-AWS b5d7042ae1 Address Liz's feedback. Fix typos
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-02-04 11:44:49 -06:00
Naarcha-AWS 8392cd19ee Add Ingest API to reference
Signed-off-by: Naarcha-AWS <naarcha@amazon.com>
2022-02-04 09:37:42 -06:00
Sergey Nuyanzin 11eca4916c
Fix misprints
Logstah => Logstash
Dashbaords => Dashboards
Speicfy => Specify

Signed-off-by: Sergey Nuyanzin <snuyanzin@gmail.com>
2022-02-01 21:53:19 +01:00
keithhc2 4bf530065b Added some context
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-01-26 15:20:12 -08:00
keithhc2 34bc1f802a Missed some files
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-01-26 14:25:06 -08:00
keithhc2 70a35c6477 Added open index and put mapping and adjusted front-matter
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-01-26 14:22:09 -08:00
keithhc2 3bfd988e42 Add clone and split APIs and bug fixes
Signed-off-by: keithhc2 <keithhc2@users.noreply.github.com>
2022-01-20 13:16:28 -08:00
Keith Chan eecaeab15f
Merge branch 'main' into index-apis 2022-01-06 11:28:06 -08:00