[Security Solution][Endpoint] Scripts library List API

x-pack/solutions/security/packages/test-api-clients/supertest/endpoint_management.gen.ts

@@ -41,7 +41,6 @@ import type { EndpointKillProcessActionRequestBodyInput } from '@kbn/security-so
 import type { EndpointScanActionRequestBodyInput } from '@kbn/security-solution-plugin/common/api/endpoint/actions/response_actions/scan/scan.gen';
 import type { EndpointSuspendProcessActionRequestBodyInput } from '@kbn/security-solution-plugin/common/api/endpoint/actions/response_actions/suspend_process/suspend_process.gen';
 import type { EndpointUnisolateActionRequestBodyInput } from '@kbn/security-solution-plugin/common/api/endpoint/actions/response_actions/unisolate/unisolate.gen';
-import type { GetEndpointMetadataListRequestQueryInput } from '@kbn/security-solution-plugin/common/api/endpoint/metadata/get_metadata.gen';
 import type {
   GetEndpointSuggestionsRequestParamsInput,
   GetEndpointSuggestionsRequestBodyInput,
@@ -256,14 +255,6 @@ const securitySolutionApiServiceFactory = (supertest: SuperTest.Agent) => ({
       .set(ELASTIC_HTTP_VERSION_HEADER, '2023-10-31')
       .set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana');
   },
-  getEndpointMetadataList(props: GetEndpointMetadataListProps, kibanaSpace: string = 'default') {
-    return supertest
-      .get(getRouteUrlForSpace('/api/endpoint/metadata', kibanaSpace))
-      .set('kbn-xsrf', 'true')
-      .set(ELASTIC_HTTP_VERSION_HEADER, '2023-10-31')
-      .set(X_ELASTIC_INTERNAL_ORIGIN_REQUEST, 'kibana')
-      .query(props.query);
-  },
   getEndpointSuggestions(props: GetEndpointSuggestionsProps, kibanaSpace: string = 'default') {
     return supertest
       .post(
@@ -390,9 +381,6 @@ export interface EndpointSuspendProcessActionProps {
 export interface EndpointUnisolateActionProps {
   body: EndpointUnisolateActionRequestBodyInput;
 }
-export interface GetEndpointMetadataListProps {
-  query: GetEndpointMetadataListRequestQueryInput;
-}
 export interface GetEndpointSuggestionsProps {
   params: GetEndpointSuggestionsRequestParamsInput;
   body: GetEndpointSuggestionsRequestBodyInput;

x-pack/solutions/security/plugins/security_solution/common/api/endpoint/metadata/get_metadata.schema.yaml

@@ -7,7 +7,7 @@ paths:
     get:
       summary: Get a metadata list
       operationId: GetEndpointMetadataList
-      x-codegen-enabled: true
+      x-codegen-enabled: false
       x-labels: [ess, serverless]
       parameters:
         - name: page
@@ -34,7 +34,18 @@ paths:
           in: query
           required: false
           schema:
-            $ref: '../model/schema/common.schema.yaml#/components/schemas/SortField'
+            allOf:
+              - $ref: '../model/schema/common.schema.yaml#/components/schemas/SortField'
+              - enum:
+                  - enrolled_at
+                  - metadata.host.hostname
+                  - host_status
+                  - metadata.Endpoint.policy.applied.name
+                  - metadata.Endpoint.policy.applied.status
+                  - metadata.host.os.name
+                  - metadata.host.ip
+                  - metadata.agent.version
+                  - last_checkin
         - name: sortDirection
           in: query
           required: false

x-pack/solutions/security/plugins/security_solution/common/api/endpoint/metadata/index.ts

@@ -6,7 +6,5 @@
  */
 
 export * from './get_metadata';
-export * from './get_metadata.gen';
-
 export * from './list_metadata';
 export * from './list_metadata.gen';

x-pack/solutions/security/plugins/security_solution/common/api/endpoint/model/schema/common.gen.ts

@@ -78,19 +78,7 @@ export const SortDirectionEnum = SortDirection.enum;
  * Determines which field is used to sort the results.
  */
 export type SortField = z.infer<typeof SortField>;
-export const SortField = z.enum([
-  'enrolled_at',
-  'metadata.host.hostname',
-  'host_status',
-  'metadata.Endpoint.policy.applied.name',
-  'metadata.Endpoint.policy.applied.status',
-  'metadata.host.os.name',
-  'metadata.host.ip',
-  'metadata.agent.version',
-  'last_checkin',
-]);
-export type SortFieldEnum = typeof SortField.enum;
-export const SortFieldEnum = SortField.enum;
+export const SortField = z.string();
 
 /**
  * A list of agent IDs. Max of 50.

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

@@ -61,16 +61,6 @@ components:
       type: string
       description: Determines which field is used to sort the results.
       example: enrolled_at
-      enum:
-        - enrolled_at
-        - metadata.host.hostname
-        - host_status
-        - metadata.Endpoint.policy.applied.name
-        - metadata.Endpoint.policy.applied.status
-        - metadata.host.os.name
-        - metadata.host.ip
-        - metadata.agent.version
-        - last_checkin
 
     AgentIds:
       oneOf:

x-pack/solutions/security/plugins/security_solution/common/api/endpoint/scripts_library/common.yaml

@@ -30,7 +30,7 @@ components:
         downloadUri:
           type: string
           description: URI to download the script file. Note that this is the relative path and does not include the space (if applicable)
-          example: /api/endpoint/action/scripts_library/123e4567-e89b-12d3-a456-426655440000/download
+          example: /api/endpoint/scripts_library/123e4567-e89b-12d3-a456-426655440000/download
         description:
           type: string
           description: Description of the script and its purpose/functionality
@@ -40,7 +40,7 @@ components:
           description: Instructions for using the script, including details around its supported input arguments
         example:
           type: string
-        executable:
+        pathToExecutable:
           type: string
           description: >
             The relative path to the file included in the archive that should be executed once its contents
@@ -72,7 +72,7 @@ components:
           name: Collect host data
           platform: [ linux, macos ]
           requiresInput: false
-          downloadUri: /api/endpoint/action/scripts_library/123e4567-e89b-12d3-a456-426655440000/download
+          downloadUri: /api/endpoint/scripts_library/123e4567-e89b-12d3-a456-426655440000/download
           description: Collects host data for investigation
           instructions: Collects host data for investigation
           example: ./collect_host_data.sh --help

x-pack/solutions/security/plugins/security_solution/common/api/endpoint/scripts_library/create_script.schema.yaml

@@ -3,7 +3,7 @@ info:
   title: Create script schema
   version: '2023-10-31'
 paths:
-  /api/endpoint/action/scripts_library:
+  /api/endpoint/scripts_library:
     post:
       summary: Create script
       operationId: EndpointScriptLibraryCreateScript
@@ -72,7 +72,7 @@ components:
         requiresInput:
           type: boolean
           description: Whether the script requires input arguments
-        executable:
+        pathToExecutable:
           type: string
           description: >
             Used only for when the uploaded script is an archive (.zip file for example).

x-pack/solutions/security/plugins/security_solution/common/api/endpoint/scripts_library/index.ts

@@ -6,3 +6,4 @@
  */
 
 export * from './create_script';
+export * from './list_scripts';

x-pack/solutions/security/plugins/security_solution/common/api/endpoint/scripts_library/list_scripts.gen.ts

@@ -0,0 +1,25 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+/*
+ * NOTICE: Do not edit this file manually.
+ * This file is automatically generated by the OpenAPI Generator, @kbn/openapi-generator.
+ *
+ * info:
+ *   title: List scripts schema
+ *   version: 2023-10-31
+ */
+
+import { z } from '@kbn/zod';
+
+import { PageSize, SortField } from '../model/schema/common.gen';
+
+export type ApiPageSize = z.infer<typeof ApiPageSize>;
+export const ApiPageSize = PageSize.merge(z.unknown());
+
+export type ApiSortField = z.infer<typeof ApiSortField>;
+export const ApiSortField = SortField.merge(z.unknown()).merge(z.unknown());

x-pack/solutions/security/plugins/security_solution/common/api/endpoint/scripts_library/list_scripts.schema.yaml

@@ -0,0 +1,100 @@
+openapi: 3.0.0
+info:
+  title: List scripts schema
+  version: '2023-10-31'
+paths:
+  /api/endpoint/scripts_library:
+    get:
+      summary: Get a list of scripts
+      operationId: EndpointScriptLibraryListScripts
+      description: Retrieve a list of scripts
+      x-codegen-enabled: false
+      x-labels: []
+#      TODO: When feature flag is enable, remove empty `x-labels` and un-comment the line below.
+#      x-labels: [ ess, serverless ]
+      parameters:
+        - name: page
+          in: query
+          required: false
+          description: Page number of the results to return. Defaults to 1.
+          schema:
+            $ref: '../model/schema/common.schema.yaml#/components/schemas/Page'
+        - name: pageSize
+          in: query
+          required: false
+          description: Number of results to return per page. Defaults to 10. Max value is 1000.
+          schema:
+            $ref: '#/components/schemas/ApiPageSize'
+        - name: sortField
+          in: query
+          required: false
+          description: The field to sort the results by. Defaults to name.
+          schema:
+            $ref: '#/components/schemas/ApiSortField'
+        - name: sortDirection
+          in: query
+          required: false
+          description: The direction to sort the results by. Defaults to asc (ascending).
+          schema:
+            $ref: '../model/schema/common.schema.yaml#/components/schemas/SortDirection'
+        - name: kuery
+          in: query
+          required: false
+          description: >
+            A KQL query string to filter the list of scripts. Nearly all fields in the script object are searchable.
+          schema:
+            allOf:
+              - $ref: '../model/schema/common.schema.yaml#/components/schemas/Kuery'
+              - example: "platform:windows"
+
+      responses:
+        '200':
+          description: List of scripts response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  page:
+                    $ref: '../model/schema/common.schema.yaml#/components/schemas/Page'
+                  pageSize:
+                    $ref: '#/components/schemas/ApiPageSize'
+                  total:
+                    type: integer
+                    description: The total number of scripts matching the query
+                  sortField:
+                    $ref: '#/components/schemas/ApiSortField'
+                  sortDirection:
+                    $ref: '../model/schema/common.schema.yaml#/components/schemas/SortDirection'
+                  data:
+                    type: array
+                    items:
+                      $ref: './common.yaml#/components/schemas/EndpointScript'
+              examples:
+                response:
+                  summary: List of scripts response example
+                  value:
+                    page: 1
+                    pageSize: 10
+                    total: 100
+                    sortField: name
+                    sortDirection: asc
+                    data: []
+
+
+components:
+  schemas:
+    ApiPageSize:
+      allOf:
+        - $ref: '../model/schema/common.schema.yaml#/components/schemas/PageSize'
+        - maximum: 1000
+    ApiSortField:
+      allOf:
+        - $ref: '../model/schema/common.schema.yaml#/components/schemas/SortField'
+        - enum:
+            - name
+            - createdAt
+            - createdBy
+            - updatedAt
+            - updatedBy
+        - example: name

x-pack/solutions/security/plugins/security_solution/common/api/endpoint/scripts_library/list_scripts.ts

@@ -0,0 +1,39 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+import { schema, type TypeOf } from '@kbn/config-schema';
+import { isScriptsLibraryKqlFilterValid } from '../../../endpoint/service/scripts_library/scripts_library_utils';
+import { ENDPOINT_DEFAULT_PAGE_SIZE } from '../../../endpoint/constants';
+import type { DeepMutable } from '../../../endpoint/types';
+
+export const ListScriptsRequestSchema = {
+  query: schema.maybe(
+    schema.object({
+      page: schema.maybe(schema.number({ defaultValue: 1, min: 1 })),
+      pageSize: schema.maybe(
+        schema.number({ defaultValue: ENDPOINT_DEFAULT_PAGE_SIZE, min: 1, max: 1000 })
+      ),
+      sortField: schema.maybe(
+        schema.oneOf([
+          schema.literal('name'),
+          schema.literal('createdAt'),
+          schema.literal('createdBy'),
+          schema.literal('updatedAt'),
+          schema.literal('updatedBy'),
+        ])
+      ),
+      sortDirection: schema.maybe(schema.oneOf([schema.literal('asc'), schema.literal('desc')])),
+      kuery: schema.maybe(
+        schema.string({
+          validate: (value) => isScriptsLibraryKqlFilterValid(value).error,
+        })
+      ),
+    })
+  ),
+};
+
+export type ListScriptsRequestQuery = DeepMutable<TypeOf<typeof ListScriptsRequestSchema.query>>;