Commit Graph
73 Commits
Author SHA1 Message Date
a87fdc0f63 Split query DSL, analyzer, and aggregation sections and add more to analyzer section (#4693)
* Add analyzer documentation

Signed-off-by: Fanit Kolchina <[email protected]>

* Add index and search analyzer pages

Signed-off-by: Fanit Kolchina <[email protected]>

* Doc review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* More doc review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Update index-analyzers.md

Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2023-08-08 09:41:55 -04:00
Alexandre Picard-LemieuxandNaarcha-AWS 96a9ecc9a1 error inside the documentation to put the index mapping strict (#4639)
"dynamic": "strict" is not under the "properties" section but at the same level.

Signed-off-by: Alexandre Picard-Lemieux <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
2023-08-03 15:51:52 -05:00
Mihir Bagchi 63347405e2 fix: mget http method typo (#4665)
* fix: mget http method typo

Signed-off-by: Mihir Bagchi <[email protected]>

* fix: removed extra line and and http methods in multi-get

Signed-off-by: Mihir Bagchi <[email protected]>

* fix: reordering according to the template

Signed-off-by: Mihir Bagchi <[email protected]>

---------

Signed-off-by: Mihir Bagchi <[email protected]>
2023-08-03 10:41:03 -04:00
Christian Adamini 7e0c6c4e04 Remove link list duplicated in related articles (#4660)
Signed-off-by: Christian Adamini <[email protected]>
2023-08-01 16:10:32 -05:00
afbfa85da1 Add index codec documentation (#4589)
* Add index codec documentation

Signed-off-by: Fanit Kolchina <[email protected]>

* Fix links

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Rewording and doc review comments

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2023-07-21 16:10:18 -04:00
Naarcha-AWSandNathan Bower 7aee5fc916 Add document limits to index and bulk pages (#4537)
* Add document limits to index and buld pages

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2023-07-19 15:43:59 -07:00
de4276a00d Adds ZSTD and ZSTD_NO_DICT codecs to core (out of sandbox) (#4421)
* documentation for zstd and zstd out of sandbox

Signed-off-by: Sarthak Aggarwal <[email protected]>

* Update _api-reference/index-apis/create-index.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Heather Halter <[email protected]>

* Update create-index.md

Added a new section with codec information

Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Heather Halter <[email protected]>

* Update create-index.md

Fixed the code samples

Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Heather Halter <[email protected]>

* Update create-index.md

Added back a heading 'Index Settings' since it caused broken links in other topics.

Signed-off-by: Heather Halter <[email protected]>

* Update create-index.md

Added the compression_level setting to the dynamic table.

Signed-off-by: Heather Halter <[email protected]>

* Update create-index.md

Added sentences about not being able to be updated dynamically.

Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/create-index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/create-index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/create-index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/create-index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/create-index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/create-index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/create-index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/create-index.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

---------

Signed-off-by: Sarthak Aggarwal <[email protected]>
Signed-off-by: Heather Halter <[email protected]>
Co-authored-by: Heather Halter <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2023-07-19 11:12:48 -07:00
a7da897b7a Add thread level details to _tasks API (#4542)
* Add thread level details to _tasks API

Signed-off-by: Jay Deng <[email protected]>

* Rewording according to style guide and formatting changes

Signed-off-by: Fanit Kolchina <[email protected]>

* Update _api-reference/tasks.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Update tasks.md

Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Jay Deng <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2023-07-14 17:28:09 -04:00
kolchfa-awsandNathan Bower f0b86602ed Add search pipeline metrics to Nodes Stats API (#4548)
* Add search pipeline metrics to Nodes Stats API

Signed-off-by: Fanit Kolchina <[email protected]>

* Add note about tags

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Add a sentence about expanding the response

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2023-07-13 14:51:14 -04:00
Jacob G 4984cfe724 Fix incorrect documentation in index-document.md and update-document.md (#4420)
Signed-off-by: Jacob Glickman <[email protected]>
2023-06-29 10:15:29 -04:00
Heather Halter 4b6e637627 Updates text and adds more API links (#4238)
Signed-off-by: Heather Halter <[email protected]>
2023-06-07 10:46:28 -07:00
mulugetamandNaarcha-AWS 817b730908 Add documentation for the custom-codecs plugin. (#3913)
* Add documentation for the custom-codecs plugin.

  - Add documentation for the custom-codecs plugin (https://github.com/opensearch-project/OpenSearch/pull/3577).

Signed-off-by: Mulugeta Mammo <[email protected]>

* Update _api-reference/index-apis/create-index.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _install-and-configure/plugins.md

Signed-off-by: Naarcha-AWS <[email protected]>

* Update _install-and-configure/plugins.md

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Mulugeta Mammo <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
2023-06-05 13:34:29 -05:00
Heather HalterandNaarcha-AWS ad2c6936c2 Adds new parameter to Clear Index Cache API (#4132)
* clearcacheAPI

Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/clear-index-cache.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/index-apis/clear-index-cache.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* editsfromteam

Signed-off-by: Heather Halter <[email protected]>

* fixedtickmarks

Signed-off-by: Heather Halter <[email protected]>

* fixedheadings

Signed-off-by: Heather Halter <[email protected]>

* fixheadings

Signed-off-by: Heather Halter <[email protected]>

* add-or

Signed-off-by: Heather Halter <[email protected]>

---------

Signed-off-by: Heather Halter <[email protected]>
Signed-off-by: Heather Halter <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
2023-05-30 10:35:13 -07:00
Heather Halter 837112f9b6 Fixes to redirects (#4195)
* redirects

Signed-off-by: Heather Halter <[email protected]>

* fixedformat

Signed-off-by: Heather Halter <[email protected]>

* fixbrokenlink

Signed-off-by: Heather Halter <[email protected]>

* fixbrokenlink

Signed-off-by: Heather Halter <[email protected]>

---------

Signed-off-by: Heather Halter <[email protected]>
2023-05-26 14:48:31 -07:00
Heather Halter acd7f1e0b7 fixlink (#4181)
Signed-off-by: Heather Halter <[email protected]>
2023-05-25 13:31:30 -07:00
Heather Halter ede85806fe updateword (#4159)
Signed-off-by: Heather Halter <[email protected]>
2023-05-24 11:08:26 -07:00
Heather Halter c1f9d6121b remove-alias (#4161)
Signed-off-by: Heather Halter <[email protected]>
2023-05-24 11:07:57 -07:00
Heather Halter 9cf4cd203e fixindexapiorder (#4146)
Signed-off-by: Heather Halter <[email protected]>
2023-05-23 08:52:25 -07:00
seittemaandNaarcha-AWS 3e3a54d312 Update update-by-query.md (#3693)
* Update update-by-query.md

Updated the slices parameter description to be in-line with what's actually available.  You can specify the string 'auto' as well.  The text is pulled from the https://github.com/opensearch-project/documentation-website/blob/main/_api-reference/document-apis/delete-by-query.md documentation to keep in sync.

* Update _api-reference/document-apis/update-by-query.md

Signed-off-by: Naarcha-AWS <[email protected]>

---------

Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
2023-05-22 17:00:09 -05:00
Heather Halter 190bdd75db Adds list to REST API reference page (#4128)
* adds list to rest api reference page

Signed-off-by: Heather Halter <[email protected]>

* tweaked wording

Signed-off-by: Heather Halter <[email protected]>

* tweaks

Signed-off-by: Heather Halter <[email protected]>

---------

Signed-off-by: Heather Halter <[email protected]>
2023-05-19 11:33:20 -07:00
5f9c0d575a Add the preference query parameter options (#4099)
* Add the preference query parameter options

Signed-off-by: Fanit Kolchina <[email protected]>

* Add more valid values

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Chris Moore <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Apply suggestions from code review

Co-authored-by: Heather Halter <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Chris Moore <[email protected]>
Co-authored-by: Heather Halter <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2023-05-18 09:50:27 -04:00
Heather HalterandNaarcha-AWS ee7d1efd02 More redirects and spelling fixes (#4093)
* redirects and spelling

Signed-off-by: Heather Halter <[email protected]>

* Update _observing-your-data/ad/index.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _observing-your-data/ad/index.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _search-plugins/knn/index.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

---------

Signed-off-by: Heather Halter <[email protected]>
Signed-off-by: Heather Halter <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
2023-05-17 09:57:14 -07:00
Heather Halter 6f6848dff8 More redirect updates (#4077)
* more redirects

Signed-off-by: Heather Halter <[email protected]>

* fixlinks

Signed-off-by: Heather Halter <[email protected]>

* fixedlinks

Signed-off-by: Heather Halter <[email protected]>

---------

Signed-off-by: Heather Halter <[email protected]>
2023-05-15 14:59:57 -07:00
astephanusandFanit Kolchina 1fb5252cd6 Adds collections landing page configuration and navigation header linking (#3812)
* Adds collections landing page configuration and navigation header linking

Signed-off-by: Aaron Stephanus <[email protected]>

* Removes unnecessary collection property from the configuration.

Signed-off-by: Aaron Stephanus <[email protected]>

* Adds links to navigation collection headers to collection index pages based on the collection name

Signed-off-by: Aaron Stephanus <[email protected]>

* Hide index pages from view and add info to formatting guide

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Aaron Stephanus <[email protected]>
Signed-off-by: Fanit Kolchina <[email protected]>
Co-authored-by: Fanit Kolchina <[email protected]>
2023-05-11 13:56:08 -04:00
kolchfa-awsandNathan Bower 76fb104897 Add Terraform provider documentation (#4035)
* Add Terraform provider documentation

Signed-off-by: Fanit Kolchina <[email protected]>

* Update _tools/terraform.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2023-05-08 16:23:04 -04:00
ec648b8f83 More redirect changes and small tweaks (#4022)
* more redirect changes and small tweaks

Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/cluster-api/cluster-allocation.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/cluster-api/cluster-awareness.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/cluster-api/cluster-health.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _api-reference/cluster-api/cluster-decommission.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Update _im-plugin/ism/managedindexes.md

Co-authored-by: Naarcha-AWS <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

---------

Signed-off-by: Heather Halter <[email protected]>
Signed-off-by: Heather Halter <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
2023-05-05 09:02:49 -07:00
Heather Halter d1c22f9f68 more api redirects (#4013)
Signed-off-by: Heather Halter <[email protected]>
2023-05-04 17:03:27 -07:00
Heather Halter 22cfcf119b CAT API redirects (#3965)
* catapi redirects

Signed-off-by: Heather Halter <[email protected]>

* data prepper redirects

Signed-off-by: Heather Halter <[email protected]>

* committing unsaved

Signed-off-by: Heather Halter <[email protected]>

---------

Signed-off-by: Heather Halter <[email protected]>
2023-05-04 11:22:52 -07:00
Heather HalterandNaarcha-AWS 8ed9a9505b More redirect fixes - index and ingestion APIs (#3975)
* more redirect fixes to index and ingest apis

Signed-off-by: Heather Halter <[email protected]>

* one more

Signed-off-by: Heather Halter <[email protected]>

---------

Signed-off-by: Heather Halter <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]>
2023-05-04 10:44:02 -07:00
kolchfa-aws 8463c8f278 Correct plugin capitalization (#3838)
* Correct plugin capitalization

Signed-off-by: Fanit Kolchina <[email protected]>

* Revert cluster-stats because the name is in response

Signed-off-by: Fanit Kolchina <[email protected]>

* Revert cluster-stats once more

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
2023-05-04 11:11:54 -04:00