Skip to content

Commit

Permalink
[8.18] [SecuritySolution][Endpoint] Update request docs for isolate/r…
Browse files Browse the repository at this point in the history
…elease/processes (#209097) (#209248)

# Backport

This will backport the following commits from `main` to `8.18`:
- [[SecuritySolution][Endpoint] Update request docs for
isolate/release/processes
(#209097)](#209097)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT
[{"author":{"name":"Ash","email":"1849116+ashokaditya@users.noreply.github.com"},"sourceCommit":{"committedDate":"2025-02-03T10:38:14Z","message":"[SecuritySolution][Endpoint]
Update request docs for isolate/release/processes
(#209097)","sha":"59a15be9777d206e3cc59e3ffb9dcf5d2beadbe8","branchLabelMapping":{"^v9.1.0$":"main","^v8.19.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","v9.0.0","Team:Defend
Workflows","OLM
Sprint","v8.16.0","backport:version","v8.17.0","v8.18.0","v9.1.0"],"title":"[SecuritySolution][Endpoint]
Update request docs for
isolate/release/processes","number":209097,"url":"https://github.com/elastic/kibana/pull/209097","mergeCommit":{"message":"[SecuritySolution][Endpoint]
Update request docs for isolate/release/processes
(#209097)","sha":"59a15be9777d206e3cc59e3ffb9dcf5d2beadbe8"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.16","8.17","8.18"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.17","label":"v8.17.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/209097","number":209097,"mergeCommit":{"message":"[SecuritySolution][Endpoint]
Update request docs for isolate/release/processes
(#209097)","sha":"59a15be9777d206e3cc59e3ffb9dcf5d2beadbe8"}}]}]
BACKPORT-->

Co-authored-by: Ash <1849116+ashokaditya@users.noreply.github.com>
  • Loading branch information
kibanamachine and ashokaditya authored Feb 3, 2025
1 parent 9d5cdbf commit 21237fd
Show file tree
Hide file tree
Showing 10 changed files with 201 additions and 109 deletions.
73 changes: 48 additions & 25 deletions oas_docs/output/kibana.serverless.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
73 changes: 48 additions & 25 deletions oas_docs/output/kibana.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
Loading

0 comments on commit 21237fd

Please sign in to comment.