Skip to content

Commit 3be43ed

Browse files
[DOCS][API] Update Security endpoint management APIs (#232205)
## Summary Resolves elastic/docs-content#2537 by updating the description of the following Security endpoint management APIs to mention how to obtain the `file_id`. - https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointfiledownload - https://www.elastic.co/docs/api/doc/kibana/operation/operation-endpointfileinfo --------- Co-authored-by: kibanamachine <[email protected]>
1 parent 053f63a commit 3be43ed

File tree

8 files changed

+89
-19
lines changed

8 files changed

+89
-19
lines changed

oas_docs/output/kibana.serverless.yaml

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10930,7 +10930,11 @@ paths:
1093010930
name: product_name
1093110931
/api/endpoint/action/{action_id}/file/{file_id}:
1093210932
get:
10933-
description: Get information for the specified file using the file ID.
10933+
description: |
10934+
Get information for the specified file using the file ID.
10935+
> info
10936+
> To construct a `file_id`, combine the `action_id` and `agent_id` values using a dot separator:
10937+
> {`file_id`} = {`action_id`}`.`{`agent_id`}
1093410938
operationId: EndpointFileInfo
1093510939
parameters:
1093610940
- in: path
@@ -10958,7 +10962,11 @@ paths:
1095810962
name: product_name
1095910963
/api/endpoint/action/{action_id}/file/{file_id}/download:
1096010964
get:
10961-
description: Download a file from an endpoint.
10965+
description: |
10966+
Download a file from an endpoint.
10967+
> info
10968+
> To construct a `file_id`, combine the `action_id` and `agent_id` values using a dot separator:
10969+
> {`file_id`} = {`action_id`}`.`{`agent_id`}
1096210970
operationId: EndpointFileDownload
1096310971
parameters:
1096410972
- in: path

oas_docs/output/kibana.yaml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13894,14 +13894,17 @@ paths:
1389413894
name: product_name
1389513895
/api/endpoint/action/{action_id}/file/{file_id}:
1389613896
get:
13897-
description: |-
13897+
description: |
1389813898
**Spaces method and path for this operation:**
1389913899

1390013900
<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/endpoint/action/{action_id}/file/{file_id}</span></div>
1390113901

1390213902
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
1390313903

1390413904
Get information for the specified file using the file ID.
13905+
> info
13906+
> To construct a `file_id`, combine the `action_id` and `agent_id` values using a dot separator:
13907+
> {`file_id`} = {`action_id`}`.`{`agent_id`}
1390513908
operationId: EndpointFileInfo
1390613909
parameters:
1390713910
- in: path
@@ -13929,14 +13932,17 @@ paths:
1392913932
name: product_name
1393013933
/api/endpoint/action/{action_id}/file/{file_id}/download:
1393113934
get:
13932-
description: |-
13935+
description: |
1393313936
**Spaces method and path for this operation:**
1393413937

1393513938
<div><span class="operation-verb get">get</span>&nbsp;<span class="operation-path">/s/{space_id}/api/endpoint/action/{action_id}/file/{file_id}/download</span></div>
1393613939

1393713940
Refer to [Spaces](https://www.elastic.co/docs/deploy-manage/manage-spaces) for more information.
1393813941

13939-
Download a file from an endpoint.
13942+
Download a file from an endpoint.
13943+
> info
13944+
> To construct a `file_id`, combine the `action_id` and `agent_id` values using a dot separator:
13945+
> {`file_id`} = {`action_id`}`.`{`agent_id`}
1394013946
operationId: EndpointFileDownload
1394113947
parameters:
1394213948
- in: path

x-pack/solutions/security/plugins/security_solution/common/api/endpoint/actions/file_download/file_download.schema.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ paths:
77
get:
88
summary: Download a file
99
operationId: EndpointFileDownload
10-
description: Download a file from an endpoint.
10+
description: |
11+
Download a file from an endpoint.
12+
> info
13+
> To construct a `file_id`, combine the `action_id` and `agent_id` values using a dot separator:
14+
> {`file_id`} = {`action_id`}`.`{`agent_id`}
1115
x-codegen-enabled: true
1216
x-labels: [ess, serverless]
1317
parameters:

x-pack/solutions/security/plugins/security_solution/common/api/endpoint/actions/file_info/file_info.schema.yaml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ paths:
77
get:
88
summary: Get file information
99
operationId: EndpointFileInfo
10-
description: Get information for the specified file using the file ID.
10+
description: |
11+
Get information for the specified file using the file ID.
12+
> info
13+
> To construct a `file_id`, combine the `action_id` and `agent_id` values using a dot separator:
14+
> {`file_id`} = {`action_id`}`.`{`agent_id`}
1115
x-codegen-enabled: true
1216
x-labels: [ess, serverless]
1317
parameters:

x-pack/solutions/security/plugins/security_solution/common/api/quickstart_client.gen.ts

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1088,8 +1088,12 @@ The difference between the `id` and `rule_id` is that the `id` is a unique rule
10881088
.catch(catchAxiosErrorFormatAndThrow);
10891089
}
10901090
/**
1091-
* Download a file from an endpoint.
1092-
*/
1091+
* Download a file from an endpoint.
1092+
> info
1093+
> To construct a `file_id`, combine the `action_id` and `agent_id` values using a dot separator:
1094+
> {`file_id`} = {`action_id`}`.`{`agent_id`}
1095+
1096+
*/
10931097
async endpointFileDownload(props: EndpointFileDownloadProps) {
10941098
this.log.info(`${new Date().toISOString()} Calling API EndpointFileDownload`);
10951099
return this.kbnClient
@@ -1106,8 +1110,12 @@ The difference between the `id` and `rule_id` is that the `id` is a unique rule
11061110
.catch(catchAxiosErrorFormatAndThrow);
11071111
}
11081112
/**
1109-
* Get information for the specified file using the file ID.
1110-
*/
1113+
* Get information for the specified file using the file ID.
1114+
> info
1115+
> To construct a `file_id`, combine the `action_id` and `agent_id` values using a dot separator:
1116+
> {`file_id`} = {`action_id`}`.`{`agent_id`}
1117+
1118+
*/
11111119
async endpointFileInfo(props: EndpointFileInfoProps) {
11121120
this.log.info(`${new Date().toISOString()} Calling API EndpointFileInfo`);
11131121
return this.kbnClient

x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_endpoint_management_api_2023_10_31.bundled.schema.yaml

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,15 @@ paths:
123123
- Security Endpoint Management API
124124
/api/endpoint/action/{action_id}/file/{file_id}:
125125
get:
126-
description: Get information for the specified file using the file ID.
126+
description: >
127+
Get information for the specified file using the file ID.
128+
129+
> info
130+
131+
> To construct a `file_id`, combine the `action_id` and `agent_id`
132+
values using a dot separator:
133+
134+
> {`file_id`} = {`action_id`}`.`{`agent_id`}
127135
operationId: EndpointFileInfo
128136
parameters:
129137
- in: path
@@ -148,7 +156,15 @@ paths:
148156
- Security Endpoint Management API
149157
/api/endpoint/action/{action_id}/file/{file_id}/download:
150158
get:
151-
description: Download a file from an endpoint.
159+
description: >
160+
Download a file from an endpoint.
161+
162+
> info
163+
164+
> To construct a `file_id`, combine the `action_id` and `agent_id`
165+
values using a dot separator:
166+
167+
> {`file_id`} = {`action_id`}`.`{`agent_id`}
152168
operationId: EndpointFileDownload
153169
parameters:
154170
- in: path

x-pack/solutions/security/plugins/security_solution/docs/openapi/serverless/security_solution_endpoint_management_api_2023_10_31.bundled.schema.yaml

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,7 +123,15 @@ paths:
123123
- Security Endpoint Management API
124124
/api/endpoint/action/{action_id}/file/{file_id}:
125125
get:
126-
description: Get information for the specified file using the file ID.
126+
description: >
127+
Get information for the specified file using the file ID.
128+
129+
> info
130+
131+
> To construct a `file_id`, combine the `action_id` and `agent_id`
132+
values using a dot separator:
133+
134+
> {`file_id`} = {`action_id`}`.`{`agent_id`}
127135
operationId: EndpointFileInfo
128136
parameters:
129137
- in: path
@@ -148,7 +156,15 @@ paths:
148156
- Security Endpoint Management API
149157
/api/endpoint/action/{action_id}/file/{file_id}/download:
150158
get:
151-
description: Download a file from an endpoint.
159+
description: >
160+
Download a file from an endpoint.
161+
162+
> info
163+
164+
> To construct a `file_id`, combine the `action_id` and `agent_id`
165+
values using a dot separator:
166+
167+
> {`file_id`} = {`action_id`}`.`{`agent_id`}
152168
operationId: EndpointFileDownload
153169
parameters:
154170
- in: path

x-pack/test/api_integration/services/security_solution_api.gen.ts

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -735,8 +735,12 @@ The difference between the `id` and `rule_id` is that the `id` is a unique rule
735735
.send(props.body as object);
736736
},
737737
/**
738-
* Download a file from an endpoint.
739-
*/
738+
* Download a file from an endpoint.
739+
> info
740+
> To construct a `file_id`, combine the `action_id` and `agent_id` values using a dot separator:
741+
> {`file_id`} = {`action_id`}`.`{`agent_id`}
742+
743+
*/
740744
endpointFileDownload(props: EndpointFileDownloadProps, kibanaSpace: string = 'default') {
741745
return supertest
742746
.get(
@@ -750,8 +754,12 @@ The difference between the `id` and `rule_id` is that the `id` is a unique rule
750754
.set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana');
751755
},
752756
/**
753-
* Get information for the specified file using the file ID.
754-
*/
757+
* Get information for the specified file using the file ID.
758+
> info
759+
> To construct a `file_id`, combine the `action_id` and `agent_id` values using a dot separator:
760+
> {`file_id`} = {`action_id`}`.`{`agent_id`}
761+
762+
*/
755763
endpointFileInfo(props: EndpointFileInfoProps, kibanaSpace: string = 'default') {
756764
return supertest
757765
.get(

0 commit comments

Comments
 (0)