Browse Source

rest-api-spec: specify default value for format in cat APIs (#134528) (#134612)

* rest-api-spec: specify default value for local in cat APIs

* Fix default value

(cherry picked from commit f0224139b1f99e780fada112e2ef21273c03bd73)
Quentin Pradet 1 month ago
parent
commit
68ea2ad7c5
25 changed files with 25 additions and 0 deletions
  1. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json
  2. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.allocation.json
  3. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.component_templates.json
  4. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.count.json
  5. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.fielddata.json
  6. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.health.json
  7. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.indices.json
  8. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.master.json
  9. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_data_frame_analytics.json
  10. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json
  11. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_jobs.json
  12. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_trained_models.json
  13. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodeattrs.json
  14. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodes.json
  15. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.pending_tasks.json
  16. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.plugins.json
  17. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json
  18. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.repositories.json
  19. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.segments.json
  20. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.shards.json
  21. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.snapshots.json
  22. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.tasks.json
  23. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.templates.json
  24. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.thread_pool.json
  25. 1 0
      rest-api-spec/src/main/resources/rest-api-spec/api/cat.transforms.json

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json

@@ -37,6 +37,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "h": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.allocation.json

@@ -37,6 +37,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "bytes": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.component_templates.json

@@ -37,6 +37,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "local": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.count.json

@@ -37,6 +37,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "h": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.fielddata.json

@@ -37,6 +37,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "bytes": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.health.json

@@ -25,6 +25,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "h": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.indices.json

@@ -37,6 +37,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "bytes": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.master.json

@@ -25,6 +25,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "local": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_data_frame_analytics.json

@@ -54,6 +54,7 @@
       },
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "h": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_datafeeds.json

@@ -42,6 +42,7 @@
       },
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "h": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_jobs.json

@@ -54,6 +54,7 @@
       },
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "h": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.ml_trained_models.json

@@ -65,6 +65,7 @@
       },
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "h": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodeattrs.json

@@ -25,6 +25,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "local": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.nodes.json

@@ -37,6 +37,7 @@
       },
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "full_id": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.pending_tasks.json

@@ -25,6 +25,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "local": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.plugins.json

@@ -25,6 +25,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "local": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.recovery.json

@@ -37,6 +37,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "active_only": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.repositories.json

@@ -25,6 +25,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "local": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.segments.json

@@ -37,6 +37,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "local": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.shards.json

@@ -37,6 +37,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "bytes": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.snapshots.json

@@ -37,6 +37,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "ignore_unavailable": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.tasks.json

@@ -25,6 +25,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "nodes": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.templates.json

@@ -37,6 +37,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "local": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.thread_pool.json

@@ -37,6 +37,7 @@
     "params": {
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "time": {

+ 1 - 0
rest-api-spec/src/main/resources/rest-api-spec/api/cat.transforms.json

@@ -52,6 +52,7 @@
       },
       "format": {
         "type": "string",
+        "default": "text",
         "description": "a short version of the Accept header, e.g. json, yaml"
       },
       "h": {