Browse Source

CONSOLEify _cat/pending_tasks docs

Relates to #18160
Nik Everett 9 years ago
parent
commit
4fbe1a8819
2 changed files with 13 additions and 4 deletions
  1. 0 1
      docs/build.gradle
  2. 13 3
      docs/reference/cat/pending_tasks.asciidoc

+ 0 - 1
docs/build.gradle

@@ -93,7 +93,6 @@ buildRestTests.expectedUnconvertedCandidates = [
   'reference/analysis/tokenfilters/stop-tokenfilter.asciidoc',
   'reference/analysis/tokenfilters/synonym-tokenfilter.asciidoc',
   'reference/analysis/tokenfilters/word-delimiter-tokenfilter.asciidoc',
-  'reference/cat/pending_tasks.asciidoc',
   'reference/cat/plugins.asciidoc',
   'reference/cat/recovery.asciidoc',
   'reference/cat/repositories.asciidoc',

+ 13 - 3
docs/reference/cat/pending_tasks.asciidoc

@@ -3,11 +3,18 @@
 
 `pending_tasks` provides the same information as the
 <<cluster-pending,`/_cluster/pending_tasks`>> API in a
-convenient tabular format.
+convenient tabular format. For example:
 
-[source,sh]
+[source,js]
+--------------------------------------------------
+GET /_cat/pending_tasks?v
+--------------------------------------------------
+// CONSOLE
+
+Might look like:
+
+[source,js]
 --------------------------------------------------
-% curl 'localhost:9200/_cat/pending_tasks?v'
 insertOrder timeInQueue priority source
        1685       855ms HIGH     update-mapping [foo][t]
        1686       843ms HIGH     update-mapping [foo][t]
@@ -17,3 +24,6 @@ insertOrder timeInQueue priority source
        1690       787ms HIGH     update-mapping [foo][t]
        1691       773ms HIGH     update-mapping [foo][t]
 --------------------------------------------------
+// TESTRESPONSE[s/(\n.+)+/(\\n.+)*/ _cat]
+// We can't assert anything about the tasks in progress here because we don't
+// know what might be in progress....