honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/cat/alias.asciidoc

60 lines
1.4 KiB
Plaintext
Raw Normal View History

[DOCS] Added documentation for CAT Aliases API Added asciidoc. Added new lines in java class.
2014-01-20 03:23:00 -05:00
[[cat-alias]]
[DOCS] Renamed the "cat" chapters to be more searchable
2014-05-16 15:43:35 -04:00
== cat aliases
[DOCS] Added documentation for CAT Aliases API Added asciidoc. Added new lines in java class.
2014-01-20 03:23:00 -05:00
`aliases` shows information about currently configured aliases to indices
including filter and routing infos.
CONSOLEify some _cat docs Added `// NOTCONSOLE` to some `_cat` docs that rely on `sort` or are otherwise too difficult for us to test at this point. Relates to #20717
2016-10-06 13:31:18 -04:00
////
Hidden setup for example:
[source,js]
--------------------------------------------------
Remove `include_type_name` in asciidoc where possible (#37568) The "include_type_name" parameter was temporarily introduced in #37285 to facilitate moving the default parameter setting to "false" in many places in the documentation code snippets. Most of the places can simply be reverted without causing errors. In this change I looked for asciidoc files that contained the "include_type_name=true" addition when creating new indices but didn't look likey they made use of the "_doc" type for mappings. This is mostly the case e.g. in the analysis docs where index creating often only contains settings. I manually corrected the use of types in some places where the docs still used an explicit type name and not the dummy "_doc" type.
2019-01-18 03:34:11 -05:00
PUT test1
CONSOLEify some _cat docs Added `// NOTCONSOLE` to some `_cat` docs that rely on `sort` or are otherwise too difficult for us to test at this point. Relates to #20717
2016-10-06 13:31:18 -04:00
{
"aliases": {
"alias1": {},
"alias2": {
"filter": {
"match": {
"user": "kimchy"
}
}
},
"alias3": {
"routing": "1"
},
"alias4": {
"index_routing": "2",
"search_routing": "1,2"
}
}
}
--------------------------------------------------
// CONSOLE
////
[source,js]
--------------------------------------------------
GET /_cat/aliases?v
--------------------------------------------------
// CONSOLE
// TEST[continued]
Might respond with:
Convert more docs to // CONSOLE Converts docs for `_cat/segments`, `_cat/plugins` and `_cat/repositories` from `curl` to `// CONSOLE` so they are tested as part of the build and are cleaner to use in Console. They should work fine with `curl` with the `COPY AS CURL` link. Also swaps the `source` type of the response from `js` to `txt` because that is more correct. The syntax highlighter doesn't care. It looks at the text to figure out the language. So it looks a little funny for `_cat` responses regardless. Relates to #18160
2016-10-25 10:56:30 -04:00
[source,txt]
[DOCS] Added documentation for CAT Aliases API Added asciidoc. Added new lines in java class.
2014-01-20 03:23:00 -05:00
--------------------------------------------------
Names of indexRouting and searchRouting infos are out of date. Hi, I belive indexRouting should be changed to routing.index and searchRouting to routing.search. This is what my ES 2.0.0-rc1 instance returns when I hit cat alias api: Let me know if I should change other versions of documentation for this issue as well(Looks to me like it always was incorrect in docs).
2015-10-15 15:55:06 -04:00
alias index filter routing.index routing.search
[DOCS] Added documentation for CAT Aliases API Added asciidoc. Added new lines in java class.
2014-01-20 03:23:00 -05:00
alias1 test1 - - -
CONSOLEify some _cat docs Added `// NOTCONSOLE` to some `_cat` docs that rely on `sort` or are otherwise too difficult for us to test at this point. Relates to #20717
2016-10-06 13:31:18 -04:00
alias2 test1 * - -
[DOCS] Added documentation for CAT Aliases API Added asciidoc. Added new lines in java class.
2014-01-20 03:23:00 -05:00
alias3 test1 - 1 1
CONSOLEify some _cat docs Added `// NOTCONSOLE` to some `_cat` docs that rely on `sort` or are otherwise too difficult for us to test at this point. Relates to #20717
2016-10-06 13:31:18 -04:00
alias4 test1 - 2 1,2
[DOCS] Added documentation for CAT Aliases API Added asciidoc. Added new lines in java class.
2014-01-20 03:23:00 -05:00
--------------------------------------------------
CONSOLEify some _cat docs Added `// NOTCONSOLE` to some `_cat` docs that rely on `sort` or are otherwise too difficult for us to test at this point. Relates to #20717
2016-10-06 13:31:18 -04:00
// TESTRESPONSE[s/[*]/[*]/ _cat]
[DOCS] Added documentation for CAT Aliases API Added asciidoc. Added new lines in java class.
2014-01-20 03:23:00 -05:00
[DOCS] Fixed various typos in the 'cat APIs' section (#23216)
2017-02-16 14:41:42 -05:00
The output shows that `alias2` has configured a filter, and specific routing
[DOCS] Renamed the "cat" chapters to be more searchable
2014-05-16 15:43:35 -04:00
configurations in `alias3` and `alias4`.
[DOCS] Added documentation for CAT Aliases API Added asciidoc. Added new lines in java class.
2014-01-20 03:23:00 -05:00
Handle multiple aliases in _cat/aliases api (#23698) The alias parameter was documented as a list in our rest-spec, yet only the first value out of a list was getting read and processed. This commit adds support for multiple aliases to _cat/aliases Closes #23661
2017-04-28 09:21:44 -04:00
If you only want to get information about specific aliases, you can specify
the aliases in comma-delimited format as a URL parameter, e.g.,
[Docs] Fix URL path to aliases (#36852) This API URL contains /aliases/aliases and that seems to be a duplicate.
2018-12-31 11:58:49 -05:00
/_cat/aliases/alias1,alias2.