[8.16][SecuritySolution][Endpoint] Update request docs for isolate/re…

…lease/processes (#210144) ## Summary Creating this new PR as `security_solution` plugin has moved between 8.16 and 8.17 and manual backports are not working cleanly for 8.16 from the main PR. follow up of #209097 ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) ### Identify risks Does this PR introduce any risks? For example, consider risks like hard to test bugs, performance regression, potential of data loss. Describe the risk, its severity, and mitigation for each identified risk. Invite stakeholders and evaluate how to proceed before merging. - [ ] [See some risk examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) - [ ] ... --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
elastic · Feb 7, 2025 · 4d74e2c · 4d74e2c
1 parent 4f2f9e8
commit 4d74e2c
Show file tree

Hide file tree

Showing 9 changed files with 153 additions and 84 deletions.
diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml
@@ -40222,9 +40222,39 @@ components:
           required:
             - parameters
     Security_Endpoint_Management_API_GetProcessesRouteRequestBody:
-      $ref: '#/components/schemas/Security_Endpoint_Management_API_NoParametersRequestSchema'
+      type: object
+      properties:
+        agent_type:
+          $ref: '#/components/schemas/Security_Endpoint_Management_API_AgentTypes'
+        alert_ids:
+          $ref: '#/components/schemas/Security_Endpoint_Management_API_AlertIds'
+        case_ids:
+          $ref: '#/components/schemas/Security_Endpoint_Management_API_CaseIds'
+        comment:
+          $ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
+        endpoint_ids:
+          $ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
+        parameters:
+          $ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
+      required:
+        - endpoint_ids
     Security_Endpoint_Management_API_IsolateRouteRequestBody:
-      $ref: '#/components/schemas/Security_Endpoint_Management_API_NoParametersRequestSchema'
+      type: object
+      properties:
+        agent_type:
+          $ref: '#/components/schemas/Security_Endpoint_Management_API_AgentTypes'
+        alert_ids:
+          $ref: '#/components/schemas/Security_Endpoint_Management_API_AlertIds'
+        case_ids:
+          $ref: '#/components/schemas/Security_Endpoint_Management_API_CaseIds'
+        comment:
+          $ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
+        endpoint_ids:
+          $ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
+        parameters:
+          $ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
+      required:
+        - endpoint_ids
     Security_Endpoint_Management_API_KillProcessRouteRequestBody:
       allOf:
         - type: object
@@ -40304,28 +40334,6 @@ components:
           type: string
       required:
         - hostStatuses
-    Security_Endpoint_Management_API_NoParametersRequestSchema:
-      type: object
-      properties:
-        body:
-          type: object
-          properties:
-            agent_type:
-              $ref: '#/components/schemas/Security_Endpoint_Management_API_AgentTypes'
-            alert_ids:
-              $ref: '#/components/schemas/Security_Endpoint_Management_API_AlertIds'
-            case_ids:
-              $ref: '#/components/schemas/Security_Endpoint_Management_API_CaseIds'
-            comment:
-              $ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
-            endpoint_ids:
-              $ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
-            parameters:
-              $ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
-          required:
-            - endpoint_ids
-      required:
-        - body
     Security_Endpoint_Management_API_Page:
       default: 1
       description: Page number
@@ -40456,7 +40464,22 @@ components:
       minLength: 1
       type: array
     Security_Endpoint_Management_API_UnisolateRouteRequestBody:
-      $ref: '#/components/schemas/Security_Endpoint_Management_API_NoParametersRequestSchema'
+      type: object
+      properties:
+        agent_type:
+          $ref: '#/components/schemas/Security_Endpoint_Management_API_AgentTypes'
+        alert_ids:
+          $ref: '#/components/schemas/Security_Endpoint_Management_API_AlertIds'
+        case_ids:
+          $ref: '#/components/schemas/Security_Endpoint_Management_API_CaseIds'
+        comment:
+          $ref: '#/components/schemas/Security_Endpoint_Management_API_Comment'
+        endpoint_ids:
+          $ref: '#/components/schemas/Security_Endpoint_Management_API_EndpointIds'
+        parameters:
+          $ref: '#/components/schemas/Security_Endpoint_Management_API_Parameters'
+      required:
+        - endpoint_ids
     Security_Endpoint_Management_API_UploadRouteRequestBody:
       allOf:
         - type: object

diff --git a/...ins/security_solution/common/api/endpoint/actions/response_actions/isolate/isolate.gen.ts b/...ins/security_solution/common/api/endpoint/actions/response_actions/isolate/isolate.gen.ts
@@ -16,10 +16,10 @@
 
 import type { z } from '@kbn/zod';
 
-import { SuccessResponse, NoParametersRequestSchema } from '../../../model/schema/common.gen';
+import { SuccessResponse, BaseActionSchema } from '../../../model/schema/common.gen';
 
 export type IsolateRouteRequestBody = z.infer<typeof IsolateRouteRequestBody>;
-export const IsolateRouteRequestBody = NoParametersRequestSchema;
+export const IsolateRouteRequestBody = BaseActionSchema;
 
 export type EndpointIsolateActionRequestBody = z.infer<typeof EndpointIsolateActionRequestBody>;
 export const EndpointIsolateActionRequestBody = IsolateRouteRequestBody;

diff --git a/...ecurity_solution/common/api/endpoint/actions/response_actions/isolate/isolate.schema.yaml b/...ecurity_solution/common/api/endpoint/actions/response_actions/isolate/isolate.schema.yaml
@@ -27,4 +27,4 @@ paths:
 components:
   schemas:
     IsolateRouteRequestBody:
-        $ref: '../../../model/schema/common.schema.yaml#/components/schemas/NoParametersRequestSchema'
+        $ref: '../../../model/schema/common.schema.yaml#/components/schemas/BaseActionSchema'
diff --git a/..._solution/common/api/endpoint/actions/response_actions/running_procs/running_procs.gen.ts b/..._solution/common/api/endpoint/actions/response_actions/running_procs/running_procs.gen.ts
@@ -16,10 +16,10 @@
 
 import type { z } from '@kbn/zod';
 
-import { SuccessResponse, NoParametersRequestSchema } from '../../../model/schema/common.gen';
+import { SuccessResponse, BaseActionSchema } from '../../../model/schema/common.gen';
 
 export type GetProcessesRouteRequestBody = z.infer<typeof GetProcessesRouteRequestBody>;
-export const GetProcessesRouteRequestBody = NoParametersRequestSchema;
+export const GetProcessesRouteRequestBody = BaseActionSchema;
 
 export type EndpointGetProcessesActionRequestBody = z.infer<
   typeof EndpointGetProcessesActionRequestBody

diff --git a/...tion/common/api/endpoint/actions/response_actions/running_procs/running_procs.schema.yaml b/...tion/common/api/endpoint/actions/response_actions/running_procs/running_procs.schema.yaml
@@ -28,4 +28,4 @@ components:
   schemas:
     GetProcessesRouteRequestBody:
       allOf:
-        - $ref: '../../../model/schema/common.schema.yaml#/components/schemas/NoParametersRequestSchema'
+        - $ref: '../../../model/schema/common.schema.yaml#/components/schemas/BaseActionSchema'
diff --git a/...security_solution/common/api/endpoint/actions/response_actions/unisolate/unisolate.gen.ts b/...security_solution/common/api/endpoint/actions/response_actions/unisolate/unisolate.gen.ts
@@ -16,10 +16,10 @@
 
 import type { z } from '@kbn/zod';
 
-import { SuccessResponse, NoParametersRequestSchema } from '../../../model/schema/common.gen';
+import { SuccessResponse, BaseActionSchema } from '../../../model/schema/common.gen';
 
 export type UnisolateRouteRequestBody = z.infer<typeof UnisolateRouteRequestBody>;
-export const UnisolateRouteRequestBody = NoParametersRequestSchema;
+export const UnisolateRouteRequestBody = BaseActionSchema;
 
 export type EndpointUnisolateActionRequestBody = z.infer<typeof EndpointUnisolateActionRequestBody>;
 export const EndpointUnisolateActionRequestBody = UnisolateRouteRequestBody;

diff --git a/...ity_solution/common/api/endpoint/actions/response_actions/unisolate/unisolate.schema.yaml b/...ity_solution/common/api/endpoint/actions/response_actions/unisolate/unisolate.schema.yaml
@@ -27,4 +27,4 @@ paths:
 components:
   schemas:
     UnisolateRouteRequestBody:
-      $ref: '../../../model/schema/common.schema.yaml#/components/schemas/NoParametersRequestSchema'
+      $ref: '../../../model/schema/common.schema.yaml#/components/schemas/BaseActionSchema'
diff --git a/...docs/openapi/ess/security_solution_endpoint_management_api_2023_10_31.bundled.schema.yaml b/...docs/openapi/ess/security_solution_endpoint_management_api_2023_10_31.bundled.schema.yaml
@@ -839,9 +839,39 @@ components:
           required:
             - parameters
     GetProcessesRouteRequestBody:
-      $ref: '#/components/schemas/NoParametersRequestSchema'
+      type: object
+      properties:
+        agent_type:
+          $ref: '#/components/schemas/AgentTypes'
+        alert_ids:
+          $ref: '#/components/schemas/AlertIds'
+        case_ids:
+          $ref: '#/components/schemas/CaseIds'
+        comment:
+          $ref: '#/components/schemas/Comment'
+        endpoint_ids:
+          $ref: '#/components/schemas/EndpointIds'
+        parameters:
+          $ref: '#/components/schemas/Parameters'
+      required:
+        - endpoint_ids
     IsolateRouteRequestBody:
-      $ref: '#/components/schemas/NoParametersRequestSchema'
+      type: object
+      properties:
+        agent_type:
+          $ref: '#/components/schemas/AgentTypes'
+        alert_ids:
+          $ref: '#/components/schemas/AlertIds'
+        case_ids:
+          $ref: '#/components/schemas/CaseIds'
+        comment:
+          $ref: '#/components/schemas/Comment'
+        endpoint_ids:
+          $ref: '#/components/schemas/EndpointIds'
+        parameters:
+          $ref: '#/components/schemas/Parameters'
+      required:
+        - endpoint_ids
     KillProcessRouteRequestBody:
       allOf:
         - type: object
@@ -921,28 +951,6 @@ components:
           type: string
       required:
         - hostStatuses
-    NoParametersRequestSchema:
-      type: object
-      properties:
-        body:
-          type: object
-          properties:
-            agent_type:
-              $ref: '#/components/schemas/AgentTypes'
-            alert_ids:
-              $ref: '#/components/schemas/AlertIds'
-            case_ids:
-              $ref: '#/components/schemas/CaseIds'
-            comment:
-              $ref: '#/components/schemas/Comment'
-            endpoint_ids:
-              $ref: '#/components/schemas/EndpointIds'
-            parameters:
-              $ref: '#/components/schemas/Parameters'
-          required:
-            - endpoint_ids
-      required:
-        - body
     Page:
       default: 1
       description: Page number
@@ -1073,7 +1081,22 @@ components:
       minLength: 1
       type: array
     UnisolateRouteRequestBody:
-      $ref: '#/components/schemas/NoParametersRequestSchema'
+      type: object
+      properties:
+        agent_type:
+          $ref: '#/components/schemas/AgentTypes'
+        alert_ids:
+          $ref: '#/components/schemas/AlertIds'
+        case_ids:
+          $ref: '#/components/schemas/CaseIds'
+        comment:
+          $ref: '#/components/schemas/Comment'
+        endpoint_ids:
+          $ref: '#/components/schemas/EndpointIds'
+        parameters:
+          $ref: '#/components/schemas/Parameters'
+      required:
+        - endpoint_ids
     UploadRouteRequestBody:
       allOf:
         - type: object

diff --git a/...enapi/serverless/security_solution_endpoint_management_api_2023_10_31.bundled.schema.yaml b/...enapi/serverless/security_solution_endpoint_management_api_2023_10_31.bundled.schema.yaml
@@ -739,9 +739,39 @@ components:
           required:
             - parameters
     GetProcessesRouteRequestBody:
-      $ref: '#/components/schemas/NoParametersRequestSchema'
+      type: object
+      properties:
+        agent_type:
+          $ref: '#/components/schemas/AgentTypes'
+        alert_ids:
+          $ref: '#/components/schemas/AlertIds'
+        case_ids:
+          $ref: '#/components/schemas/CaseIds'
+        comment:
+          $ref: '#/components/schemas/Comment'
+        endpoint_ids:
+          $ref: '#/components/schemas/EndpointIds'
+        parameters:
+          $ref: '#/components/schemas/Parameters'
+      required:
+        - endpoint_ids
     IsolateRouteRequestBody:
-      $ref: '#/components/schemas/NoParametersRequestSchema'
+      type: object
+      properties:
+        agent_type:
+          $ref: '#/components/schemas/AgentTypes'
+        alert_ids:
+          $ref: '#/components/schemas/AlertIds'
+        case_ids:
+          $ref: '#/components/schemas/CaseIds'
+        comment:
+          $ref: '#/components/schemas/Comment'
+        endpoint_ids:
+          $ref: '#/components/schemas/EndpointIds'
+        parameters:
+          $ref: '#/components/schemas/Parameters'
+      required:
+        - endpoint_ids
     KillProcessRouteRequestBody:
       allOf:
         - type: object
@@ -821,28 +851,6 @@ components:
           type: string
       required:
         - hostStatuses
-    NoParametersRequestSchema:
-      type: object
-      properties:
-        body:
-          type: object
-          properties:
-            agent_type:
-              $ref: '#/components/schemas/AgentTypes'
-            alert_ids:
-              $ref: '#/components/schemas/AlertIds'
-            case_ids:
-              $ref: '#/components/schemas/CaseIds'
-            comment:
-              $ref: '#/components/schemas/Comment'
-            endpoint_ids:
-              $ref: '#/components/schemas/EndpointIds'
-            parameters:
-              $ref: '#/components/schemas/Parameters'
-          required:
-            - endpoint_ids
-      required:
-        - body
     Page:
       default: 1
       description: Page number
@@ -973,7 +981,22 @@ components:
       minLength: 1
       type: array
     UnisolateRouteRequestBody:
-      $ref: '#/components/schemas/NoParametersRequestSchema'
+      type: object
+      properties:
+        agent_type:
+          $ref: '#/components/schemas/AgentTypes'
+        alert_ids:
+          $ref: '#/components/schemas/AlertIds'
+        case_ids:
+          $ref: '#/components/schemas/CaseIds'
+        comment:
+          $ref: '#/components/schemas/Comment'
+        endpoint_ids:
+          $ref: '#/components/schemas/EndpointIds'
+        parameters:
+          $ref: '#/components/schemas/Parameters'
+      required:
+        - endpoint_ids
     UploadRouteRequestBody:
       allOf:
         - type: object