Commit Graph

42 Commits

Author SHA1 Message Date
James Rodewig 2831535cf9 [DOCS] Replace "// CONSOLE" comments with [source,console] () 2019-09-13 11:44:54 -04:00
James Rodewig f04573f8e8
[DOCS] [5 of 5] Change // TESTRESPONSE comments to [source,console-results] () () 2019-09-06 16:09:09 -04:00
James Rodewig c46c57d439
[DOCS] Change // CONSOLE comments to [source,console] () () 2019-09-06 11:31:13 -04:00
James Rodewig 96a4dc21e0 [DOCS] Re-add versioning to put template docs ()
Adds documentation for index template versioning
accidentally removed with .
2019-09-05 10:18:36 -04:00
James Rodewig f4dd3ccf32 [DOCS] Reformat "put index template" API docs () 2019-09-04 12:51:59 -04:00
James Rodewig 034a37aa01 [DOCS] Add "get index template" API docs () 2019-09-04 10:58:50 -04:00
James Rodewig c4aa8e0d90 [DOCS] Add "index template exists" API docs () 2019-08-29 13:20:20 -04:00
James Rodewig a63f60b776 [DOCS] Remove heading offsets for REST APIs ()
Several files in the REST APIs nav section are included using
:leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.)
in those files and removes the :leveloffset: tags.

Other supporting changes:
* Alphabetizes top-level REST API nav items.
* Change 'indices APIs' heading to 'index APIs.'
* Changes 'Snapshot lifecycle management' heading to sentence case.
2019-07-19 14:36:06 -04:00
Julie Tibshirani 36a3b84fc9
Update the default for include_type_name to false. ()
* Default include_type_name to false for get and put mappings.

* Default include_type_name to false for get field mappings.

* Add a constant for the default include_type_name value.

* Default include_type_name to false for get and put index templates.

* Default include_type_name to false for create index.

* Update create index calls in REST documentation to use include_type_name=true.

* Some minor clean-ups around the get index API.

* In REST tests, use include_type_name=true by default for index creation.

* Make sure to use 'expression == false'.

* Clarify the different IndexTemplateMetaData toXContent methods.

* Fix FullClusterRestartIT#testSnapshotRestore.

* Fix the ml_anomalies_default_mappings test.

* Fix GetFieldMappingsResponseTests and GetIndexTemplateResponseTests.

We make sure to specify include_type_name=true during xContent parsing,
so we continue to test the legacy typed responses. XContent generation
for the typeless responses is currently only covered by REST tests,
but we will be adding unit test coverage for these as we implement
each typeless API in the Java HLRC.

This commit also refactors GetMappingsResponse to follow the same appraoch
as the other mappings-related responses, where we read include_type_name
out of the xContent params, instead of creating a second toXContent method.
This gives better consistency in the response parsing code.

* Fix more REST tests.

* Improve some wording in the create index documentation.

* Add a note about types removal in the create index docs.

* Fix SmokeTestMonitoringWithSecurityIT#testHTTPExporterWithSSL.

* Make sure to mention include_type_name in the REST docs for affected APIs.

* Make sure to use 'expression == false' in FullClusterRestartIT.

* Mention include_type_name in the REST templates docs.
2019-01-14 13:08:01 -08:00
Ryan Ernst 254d1e8f22
Core: Add backcompat for joda time formats ()
This commit adds deprecation warnings when using format specifiers with
joda data formats that will change with java time. It also adds the "8"
prefix which may be used to force the new java time format parsing.
2018-12-13 12:26:51 -08:00
Peter Dyson 63a9571c4c
Explain nondeterministic template merging () 2018-11-30 14:56:32 +10:00
Senthil e27a0d5b0d Docs: Align prose with snippet ()
Modified example text to include multiple index patterns used in the code
2018-10-25 16:51:18 -04:00
Itamar Syn-Hershko 526f906927 Remove usage of explicit type in docs () 2018-06-04 09:42:29 -04:00
Jason Tedor a7895839a0 Reformat paragraph in template docs to 80 columns
This commit reformats a paragraph in the template docs to fit in 80
columns as for the rest of the doc, and as-is a standard that we loosely
adhere to.
2017-10-12 17:52:43 -04:00
Pius 1125bc635c Clarify settings and template on create index
This commit clarifies the interaction between settings specified in a
create index request, and those that would come from any templates that
apply to the create index request.

Relates 
2017-10-12 17:48:57 -04:00
markwalkom 746487c3f3 Update templates.asciidoc ()
Dropped in a few links to index settings and mappings to make things easier to jump to.
2017-08-08 11:29:11 +02:00
Sakthipriyan Vairamani 52d4cd504a minor grammatical improvements () 2016-11-18 08:55:04 -07:00
Alexander Lin 0219a211d3 Allows multiple patterns to be specified for index templates ()
* Allows for an array of index template patterns to be provided to an
index template, and rename the field from 'template' to 'index_pattern'.

Closes 
2016-11-10 18:00:30 -05:00
Chris Earle c2894d2362 Add missing '// CONSOLE' to code snippet 2016-10-18 12:57:03 -04:00
Chris Earle 9cf7214380 [DOCS] Add "version" to template and pipeline docs ()
* [DOCS] Add "version" to template and pipeline docs

This adds details about the "version" to both the template and pipeline pages.
2016-10-18 11:56:18 -04:00
Lucas Bremgartner 4bf45e53a5 Documentation: comments in index templates ()
Fixes 
2016-10-08 12:38:45 +02:00
Nik Everett bfd072bc10 Switch more docs to CONSOLE
Related to 
2016-09-02 18:22:30 -04:00
Clinton Gormley 3f594089c2 Renamed all AUTOSENSE snippets to CONSOLE () 2016-05-09 15:42:23 +02:00
Nik Everett 4b1c116461 Generate and run tests from the docs
Adds infrastructure so `gradle :docs:check` will extract tests from
snippets in the documentation and execute the tests. This is included
in `gradle check` so it should happen on CI and during a normal build.

By default each `// AUTOSENSE` snippet creates a unique REST test. These
tests are executed in a random order and the cluster is wiped between
each one. If multiple snippets chain together into a test you can annotate
all snippets after the first with `// TEST[continued]` to have the
generated tests for both snippets joined.

Snippets marked as `// TESTRESPONSE` are checked against the response
of the last action.

See docs/README.asciidoc for lots more.

Closes . That issue is about catching bugs in the docs during build.
This catches *some* bugs in the docs during build which is a good start.
2016-05-05 13:58:03 -04:00
Mahmoud Lababidi 20b398daea Add a more descriptive example to Index Template
Closes 
The current example in the documentation for Index Templates lacks any properties values. This is helpful to many devs that aren't sure how to take a regular Index Mapping and convert it to a template.
2016-04-06 12:18:10 +02:00
Clinton Gormley 18c5ea8599 Update templates.asciidoc
Relates to 
2016-03-31 11:15:57 +02:00
Clinton Gormley ad3234d475 Merge pull request from dylan8902/patch-1
adds grammar correction
2015-08-24 14:59:43 +02:00
Ryan Ernst e7618b8528 Settings: Remove file based index templates
As a follow up to , this removes support for
index templates on disk. It also removes a missed
place still allowing disk based mappings.

closes 
2015-05-11 12:51:22 -07:00
javanna 88e506e58c [DOCS] add -i flag to more curl HEAD calls 2015-03-21 08:56:20 +01:00
Al Lefebvre 94f82368f0 Update templates.asciidoc
I've been attempting to programatically verify that adding index templates via the `{path.conf}/templates/` directory works fine although I was never able to validate this via an API call to the `/_template/`.  It seems that these templates do not appear in that API call, which I discovered in the following mail thread:

http://elasticsearch-users.115913.n3.nabble.com/Loading-of-index-settings-template-from-file-in-config-templates-td4024923.html#d1366317284000-912

My question is why wouldn't the `/_template/*` method return these templates?  This tends to complicate things for those that want to perform automated tests to verify that they are in fact being recognized and used by Elasticsearch.
2015-03-20 14:52:20 -06:00
Sebastian Ziebell 3a6c6f4b26 Docs: Adds documentation for indices.exists_template
Closes: 
2014-11-25 19:36:01 +01:00
Clinton Gormley cb00d4a542 Docs: Removed all the added/deprecated tags from 1.x 2014-09-26 21:04:42 +02:00
Alexander Reelsen d4fcf23057 Cluster State API: Remove index template filtering
The possibility of filtering for index templates in the cluster state API
had been introduced before there was a dedicated index templates API. This
commit removes this support from the cluster state API, as it was not really
clean, requiring you to specify the metadata and the index templates.

Closes 
2014-05-05 14:54:14 +02:00
bleskes 5d832374dd Update Documentation Feature Flags [1.1.0] 2014-03-25 17:51:30 +01:00
Konrad Feldmeier d7b0d547d4 [DOCS] Multiple doc fixes
Closes 
2014-03-07 14:24:58 +01:00
James Brook a93d6d55a5 Added support for aliases to index templates
Adapted existing PR () to updated code (post ), added tests and docs (@javanna)

Closes 
2014-03-06 11:11:07 +01:00
Clinton Gormley 93930d6dc7 Removed 0.90.* deprecation and addition notifications
Closes 
2014-02-07 20:52:49 +01:00
Clinton Gormley e53a26ff21 [DOCS] Fixed a typo in indices.get_templates 2013-10-03 11:40:29 +02:00
Lee Hinman 0442b737be Add more anchor links to documentation
Related to 
2013-09-30 13:13:16 -06:00
David Pilato ea4988e9dc Support for REST get ALL templates.
/_template shows: No handler found for uri [/_template] and method [GET]

It would make sense to list the templates as they are listed in the /_cluster/state call.

Closes .
2013-09-13 15:08:59 +02:00
Clinton Gormley 047c86e3b2 [DOCS] Added wildcard template matching 2013-09-04 23:20:55 +02:00
Clinton Gormley 822043347e Migrated documentation into the main repo 2013-08-29 01:24:34 +02:00