浏览代码

Replace all index date-math examples with the URI encoded form

Closes #21454
Clinton Gormley 9 年之前
父节点
当前提交
860efb2ad2
共有 2 个文件被更改,包括 12 次插入8 次删除
  1. 9 6
      docs/reference/api-conventions.asciidoc
  2. 3 2
      docs/reference/indices/rollover-index.asciidoc

+ 9 - 6
docs/reference/api-conventions.asciidoc

@@ -84,11 +84,13 @@ Where:
 `date_format`:: is the optional format in which the computed date should be rendered. Defaults to `YYYY.MM.dd`.
 `time_zone`:: is the optional time zone . Defaults to `utc`.
 
-You must enclose date math index name expressions within angle brackets. For example:
+You must enclose date math index name expressions within angle brackets, and
+all special characters should be URI encoded. For example:
 
 [source,js]
 ----------------------------------------------------------------------
-GET /<logstash-{now/d}>/_search
+# GET /<logstash-{now/d}>/_search
+GET /%3Clogstash-%7Bnow%2Fd%7D%3E/_search
 {
   "query" : {
     "match": {
@@ -99,12 +101,12 @@ GET /<logstash-{now/d}>/_search
 ----------------------------------------------------------------------
 // CONSOLE
 // TEST[s/^/PUT logstash-2016.09.20\n/]
-// TEST[s/\{now\//{2016.09.20||%2f/]
+// TEST[s/now/2016.09.20||/]
 
 [NOTE]
 .Percent encoding of date math characters
 ======================================================
-The special characters used for date rounding must be url encoded as follows:
+The special characters used for date rounding must be URI encoded as follows:
 
 [horizontal]
 `<`:: `%3C`
@@ -141,7 +143,8 @@ three days, assuming the indices use the default Logstash index name format,
 
 [source,js]
 ----------------------------------------------------------------------
-GET /<logstash-{now%2Fd-2d}>,<logstash-{now%2Fd-1d}>,<logstash-{now%2Fd}>/_search
+# GET /<logstash-{now/d-2d}>,<logstash-{now/d-1d}>,<logstash-{now/d}>/_search
+GET /%3Clogstash-%7Bnow%2Fd-2d%7D%3E%2C%3Clogstash-%7Bnow%2Fd-1d%7D%3E%2C%3Clogstash-%7Bnow%2Fd%7D%3E/_search
 {
   "query" : {
     "match": {
@@ -152,7 +155,7 @@ GET /<logstash-{now%2Fd-2d}>,<logstash-{now%2Fd-1d}>,<logstash-{now%2Fd}>/_searc
 ----------------------------------------------------------------------
 // CONSOLE
 // TEST[s/^/PUT logstash-2016.09.20\nPUT logstash-2016.09.19\nPUT logstash-2016.09.18\n/]
-// TEST[s/\{now/{2016.09.20||/]
+// TEST[s/now/2016.09.20||/]
 
 [[common-options]]
 == Common options

+ 3 - 2
docs/reference/indices/rollover-index.asciidoc

@@ -154,11 +154,12 @@ over indices created in the last three days, you could do the following:
 
 [source,js]
 --------------------------------------------------
-GET /<logs-{now/d}-*>,<logs-{now/d-1d}-*>,<logs-{now/d-2d}-*>/_search
+# GET /<logs-{now/d}-*>,<logs-{now/d-1d}-*>,<logs-{now/d-2d}-*>/_search
+GET /%3Clogs-%7Bnow%2Fd%7D-*%3E%2C%3Clogs-%7Bnow%2Fd-1d%7D-*%3E%2C%3Clogs-%7Bnow%2Fd-2d%7D-*%3E/_search
 --------------------------------------------------
 // CONSOLE
 // TEST[continued]
-// TEST[s/now\//now%2f/]
+// TEST[s/now/2016.10.31||/]
 
 [float]
 === Defining the new index