Adding PUT runtime field

elastic · Aug 14, 2023 · 0084851 · 0084851
1 parent b30f481
commit 0084851
Show file tree

Hide file tree

Showing 3 changed files with 95 additions and 0 deletions.
diff --git a/src/plugins/data_views/docs/openapi/bundled.json b/src/plugins/data_views/docs/openapi/bundled.json
@@ -332,6 +332,46 @@
               }
             }
           }
+        }
+      },
+      "put": {
+        "summary": "Create or update an existing runtime field.",
+        "operationId": "updateRuntimeField",
+        "description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.\n",
+        "tags": [
+          "data views"
+        ],
+        "parameters": [
+          {
+            "$ref": "#/components/parameters/kbn_xsrf"
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "data_view_id": {
+                    "description": "The ID of the data view.",
+                    "type": "string",
+                    "required": true
+                  },
+                  "space_id": {
+                    "description": "An identifier for the space. If space_id is not provided in the URL, the default space is used.",
+                    "type": "string",
+                    "required": false
+                  }
+                }
+              },
+              "examples": {
+                "updateRuntimeFieldRequest": {
+                  "$ref": "#/components/examples/create_runtime_field_request"
+                }
+              }
+            }
+          }
         },
         "responses": {
           "200": {

diff --git a/src/plugins/data_views/docs/openapi/bundled.yaml b/src/plugins/data_views/docs/openapi/bundled.yaml
@@ -202,6 +202,33 @@ paths:
             examples:
               createRuntimeFieldRequest:
                 $ref: '#/components/examples/create_runtime_field_request'
+    put:
+      summary: Create or update an existing runtime field.
+      operationId: updateRuntimeField
+      description: |
+        This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
+      tags:
+        - data views
+      parameters:
+        - $ref: '#/components/parameters/kbn_xsrf'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                data_view_id:
+                  description: The ID of the data view.
+                  type: string
+                  required: true
+                space_id:
+                  description: An identifier for the space. If space_id is not provided in the URL, the default space is used.
+                  type: string
+                  required: false
+            examples:
+              updateRuntimeFieldRequest:
+                $ref: '#/components/examples/create_runtime_field_request'
       responses:
         '200':
           description: Indicates a successful call.

diff --git a/...lugins/data_views/docs/openapi/paths/api@data_views@data_view@{viewid}@runtime_field.yaml b/...lugins/data_views/docs/openapi/paths/api@data_views@data_view@{viewid}@runtime_field.yaml
@@ -25,6 +25,34 @@ post:
         examples:
           createRuntimeFieldRequest:
             $ref: '../components/examples/create_runtime_field_request.yaml'
+
+put:
+  summary: Create or update an existing runtime field.
+  operationId: updateRuntimeField 
+  description: >
+    This functionality is in technical preview and may be changed or removed in a future release. Elastic will apply best effort to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
+  tags:
+    - data views
+  parameters:
+    - $ref: '../components/headers/kbn_xsrf.yaml'
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+          type: object
+          properties:
+            data_view_id:
+              description: The ID of the data view.
+              type: string
+              required: true
+            space_id:
+              description: An identifier for the space. If space_id is not provided in the URL, the default space is used.
+              type: string
+              required: false
+        examples:
+          updateRuntimeFieldRequest:
+            $ref: '../components/examples/create_runtime_field_request.yaml'
   responses:
     '200':
       description: Indicates a successful call.