[OAS] Adding update and delete to runtime fields OAS (#163777)

This PR drafts openAPI specifications for:

- [Delete runtime field
API](https://www.elastic.co/guide/en/kibana/master/data-views-runtime-field-api-delete.html).
- [Update runtime field
API](https://www.elastic.co/guide/en/kibana/master/data-views-runtime-field-api-update.html)

Relates to #137240

src/plugins/data_views/docs/openapi/bundled.json

@@ -462,6 +462,99 @@
           }
         }
       },
+      "delete": {
+        "summary": "Delete a runtime field from a data view.",
+        "operationId": "deleteRuntimeField",
+        "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/field_name"
+          },
+          {
+            "$ref": "#/components/parameters/view_id"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Indicates a successful call."
+          },
+          "404": {
+            "description": "Object is not found.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/404_response"
+                }
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "summary": "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/field_name"
+          },
+          {
+            "$ref": "#/components/parameters/view_id"
+          }
+        ],
+        "requestBody": {
+          "required": true,
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "data_view": {
+                    "type": "object"
+                  },
+                  "fields": {
+                    "type": "array",
+                    "items": {
+                      "type": "object"
+                    }
+                  }
+                }
+              },
+              "examples": {
+                "updateRuntimeFieldRequest": {
+                  "$ref": "#/components/examples/update_runtime_field_request"
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Indicates a successful call."
+          },
+          "400": {
+            "description": "Bad request",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/400_response"
+                }
+              }
+            }
+          }
+        },
+        "servers": [
+          {
+            "url": "https://localhost:5601"
+          }
+        ]
+      },
       "servers": [
         {
           "url": "https://localhost:5601"
@@ -2434,6 +2527,16 @@
           }
         }
       },
+      "update_runtime_field_request": {
+        "summary": "Update an existing runtime field on a data view.",
+        "value": {
+          "runtimeField": {
+            "script": {
+              "source": "emit(doc[\"bar\"].value)"
+            }
+          }
+        }
+      },
       "get_default_data_view_response": {
         "summary": "The get default data view API returns the default data view identifier.",
         "value": {

src/plugins/data_views/docs/openapi/bundled.yaml

@@ -280,6 +280,62 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/404_response'
+    delete:
+      summary: Delete a runtime field from a data view.
+      operationId: deleteRuntimeField
+      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/field_name'
+        - $ref: '#/components/parameters/view_id'
+      responses:
+        '200':
+          description: Indicates a successful call.
+        '404':
+          description: Object is not found.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/404_response'
+    post:
+      summary: 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/field_name'
+        - $ref: '#/components/parameters/view_id'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                data_view:
+                  type: object
+                fields:
+                  type: array
+                  items:
+                    type: object
+            examples:
+              updateRuntimeFieldRequest:
+                $ref: '#/components/examples/update_runtime_field_request'
+      responses:
+        '200':
+          description: Indicates a successful call.
+        '400':
+          description: Bad request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/400_response'
+      servers:
+        - url: https://localhost:5601
     servers:
       - url: https://localhost:5601
   /api/data_views/default:
@@ -1832,6 +1888,12 @@ components:
           fieldAttrs: {}
           allowNoIndex: false
           name: Kibana Sample Data Flights
+    update_runtime_field_request:
+      summary: Update an existing runtime field on a data view.
+      value:
+        runtimeField:
+          script:
+            source: emit(doc["bar"].value)
     get_default_data_view_response:
       summary: The get default data view API returns the default data view identifier.
       value:

src/plugins/data_views/docs/openapi/components/examples/update_runtime_field_request.yaml

@@ -0,0 +1,9 @@
+summary: Update an existing runtime field on a data view.
+value:
+  {
+     "runtimeField": {
+     "script": {
+        "source": 'emit(doc["bar"].value)'
+      }
+  }
+}

src/plugins/data_views/docs/openapi/paths/api@data_views@data_view@{viewid}@runtime_field@{fieldname}.yaml

@@ -31,5 +31,63 @@ get:
         application/json:
           schema:
             $ref: '../components/schemas/404_response.yaml'
+
+delete:
+  summary: Delete a runtime field from a data view.
+  operationId: deleteRuntimeField
+  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/field_name.yaml'
+    - $ref: '../components/parameters/view_id.yaml'
+  responses:
+    '200':
+      description: Indicates a successful call.
+    '404':
+      description: Object is not found.
+      content:
+        application/json:
+          schema:
+            $ref: '../components/schemas/404_response.yaml'
+
+post:
+  summary: 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/field_name.yaml'
+    - $ref: '../components/parameters/view_id.yaml'
+  requestBody:
+    required: true
+    content:
+      application/json:
+        schema:
+            type: object
+            properties:
+              data_view:
+                type: object
+              fields:
+                type: array
+                items:
+                  type: object
+        examples:
+          updateRuntimeFieldRequest:
+            $ref: '../components/examples/update_runtime_field_request.yaml'
+  responses:
+    '200':
+      description: Indicates a successful call.
+    '400':
+      description: Bad request
+      content:
+        application/json:
+          schema:
+            $ref: '../components/schemas/400_response.yaml'
+  servers:
+    - url: https://localhost:5601            
 servers:
   - url: https://localhost:5601