[SecuritySolution][Endpoint] Update request docs for isolate/release/…

…processes (#209097) (cherry picked from commit 59a15be)
elastic · Feb 3, 2025 · 9bd3849 · 9bd3849
1 parent 9d5cdbf
commit 9bd3849
Show file tree

Hide file tree

Showing 10 changed files with 201 additions and 109 deletions.
diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml
@@ -47205,7 +47205,22 @@ 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_HostPathScriptParameters:
       type: object
       properties:
@@ -47224,7 +47239,22 @@ components:
       required:
         - hostPath
     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
@@ -47309,28 +47339,6 @@ components:
       minLength: 1
       pattern: ^(?! *$).+$
       type: string
-    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
@@ -47483,7 +47491,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/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml
@@ -35590,7 +35590,22 @@ 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_HostPathScriptParameters:
       type: object
       properties:
@@ -35609,7 +35624,22 @@ components:
       required:
         - hostPath
     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
@@ -35694,28 +35724,6 @@ components:
       format: nonempty
       minLength: 1
       type: string
-    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
@@ -35874,7 +35882,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
@@ -876,7 +876,22 @@ 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
     HostPathScriptParameters:
       type: object
       properties:
@@ -895,7 +910,22 @@ components:
       required:
         - hostPath
     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
@@ -980,28 +1010,6 @@ components:
       format: nonempty
       minLength: 1
       type: string
-    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
@@ -1162,7 +1170,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