[Security Solution] Add missing Lists API OpenAPI specifications

.buildkite/scripts/steps/code_generation/security_solution_codegen.sh

@@ -6,5 +6,17 @@ source .buildkite/scripts/common/util.sh
 
 echo --- Security Solution OpenAPI Code Generation
 
+echo OpenAPI Common Package
+
+(cd packages/kbn-openapi-common && yarn openapi:generate)
+check_for_changed_files "yarn openapi:generate" true
+
+echo Lists API Common Package
+
+(cd packages/kbn-securitysolution-lists-common && yarn openapi:generate)
+check_for_changed_files "yarn openapi:generate" true
+
+echo Security Solution Plugin
+
 (cd x-pack/plugins/security_solution && yarn openapi:generate)
 check_for_changed_files "yarn openapi:generate" true

.github/CODEOWNERS

@@ -621,6 +621,7 @@ x-pack/plugins/observability_solution/observability_shared @elastic/observabilit
 x-pack/test/security_api_integration/plugins/oidc_provider @elastic/kibana-security
 test/common/plugins/otel_metrics @elastic/obs-ux-infra_services-team
 packages/kbn-openapi-bundler @elastic/security-detection-rule-management
+packages/kbn-openapi-common @elastic/security-detection-rule-management
 packages/kbn-openapi-generator @elastic/security-detection-rule-management
 packages/kbn-optimizer @elastic/kibana-operations
 packages/kbn-optimizer-webpack-helpers @elastic/kibana-operations
@@ -751,6 +752,7 @@ packages/kbn-securitysolution-list-api @elastic/security-detection-engine
 packages/kbn-securitysolution-list-constants @elastic/security-detection-engine
 packages/kbn-securitysolution-list-hooks @elastic/security-detection-engine
 packages/kbn-securitysolution-list-utils @elastic/security-detection-engine
+packages/kbn-securitysolution-lists-common @elastic/security-detection-engine
 packages/kbn-securitysolution-rules @elastic/security-detection-engine
 packages/kbn-securitysolution-t-grid @elastic/security-detection-engine
 packages/kbn-securitysolution-utils @elastic/security-detection-engine

package.json

@@ -646,6 +646,7 @@
     "@kbn/observability-shared-plugin": "link:x-pack/plugins/observability_solution/observability_shared",
     "@kbn/oidc-provider-plugin": "link:x-pack/test/security_api_integration/plugins/oidc_provider",
     "@kbn/open-telemetry-instrumented-plugin": "link:test/common/plugins/otel_metrics",
+    "@kbn/openapi-common": "link:packages/kbn-openapi-common",
     "@kbn/osquery-io-ts-types": "link:packages/kbn-osquery-io-ts-types",
     "@kbn/osquery-plugin": "link:x-pack/plugins/osquery",
     "@kbn/paertial-results-example-plugin": "link:examples/partial_results_example",
@@ -761,6 +762,7 @@
     "@kbn/securitysolution-list-constants": "link:packages/kbn-securitysolution-list-constants",
     "@kbn/securitysolution-list-hooks": "link:packages/kbn-securitysolution-list-hooks",
     "@kbn/securitysolution-list-utils": "link:packages/kbn-securitysolution-list-utils",
+    "@kbn/securitysolution-lists-common": "link:packages/kbn-securitysolution-lists-common",
     "@kbn/securitysolution-rules": "link:packages/kbn-securitysolution-rules",
     "@kbn/securitysolution-t-grid": "link:packages/kbn-securitysolution-t-grid",
     "@kbn/securitysolution-utils": "link:packages/kbn-securitysolution-utils",

packages/kbn-openapi-common/README.md

@@ -0,0 +1,3 @@
+# OpenAPI Common Schemas
+
+This package contains common reusable schemas like `NonEmptyString` to be reused by any OpenAPI specification defined inside Kibana.

packages/kbn-openapi-common/kibana.jsonc

@@ -0,0 +1,5 @@
+{
+  "type": "shared-common",
+  "id": "@kbn/openapi-common",
+  "owner": "@elastic/security-detection-rule-management"
+}

packages/kbn-openapi-common/package.json

@@ -0,0 +1,11 @@
+{
+  "description": "OpenAPI common schemas for Kibana",
+  "license": "SSPL-1.0 OR Elastic License 2.0",
+  "name": "@kbn/openapi-common",
+  "private": true,
+  "version": "1.0.0",
+  "scripts": {
+    "openapi:generate": "node scripts/openapi_generate"
+  }
+}
+

packages/kbn-openapi-common/schemas/error_responses.gen.ts

@@ -0,0 +1,31 @@
+/*
+ * 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 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+/*
+ * NOTICE: Do not edit this file manually.
+ * This file is automatically generated by the OpenAPI Generator, @kbn/openapi-generator.
+ *
+ * info:
+ *   title: Error response schemas
+ *   version: not applicable
+ */
+
+import { z } from 'zod';
+
+export type PlatformErrorResponse = z.infer<typeof PlatformErrorResponse>;
+export const PlatformErrorResponse = z.object({
+  statusCode: z.number().int(),
+  error: z.string(),
+  message: z.string(),
+});
+
+export type SiemErrorResponse = z.infer<typeof SiemErrorResponse>;
+export const SiemErrorResponse = z.object({
+  status_code: z.number().int(),
+  message: z.string(),
+});

packages/kbn-openapi-common/schemas/error_responses.schema.yaml

@@ -0,0 +1,32 @@
+openapi: 3.0.0
+info:
+  title: Error response schemas
+  version: 'not applicable'
+paths: {}
+components:
+  x-codegen-enabled: true
+  schemas:
+    PlatformErrorResponse:
+      type: object
+      properties:
+        statusCode:
+          type: integer
+        error:
+          type: string
+        message:
+          type: string
+      required:
+        - statusCode
+        - error
+        - message
+
+    SiemErrorResponse:
+      type: object
+      properties:
+        status_code:
+          type: integer
+        message:
+          type: string
+      required:
+        - status_code
+        - message

packages/kbn-openapi-common/schemas/primitives.gen.ts

@@ -0,0 +1,33 @@
+/*
+ * 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 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+/*
+ * NOTICE: Do not edit this file manually.
+ * This file is automatically generated by the OpenAPI Generator, @kbn/openapi-generator.
+ *
+ * info:
+ *   title: Shared Primitives Schema
+ *   version: not applicable
+ */
+
+import { z } from 'zod';
+
+/**
+ * A string that is not empty and does not contain only whitespace
+ */
+export type NonEmptyString = z.infer<typeof NonEmptyString>;
+export const NonEmptyString = z
+  .string()
+  .min(1)
+  .regex(/^(?! *$).+$/);
+
+/**
+ * A universally unique identifier
+ */
+export type UUID = z.infer<typeof UUID>;
+export const UUID = z.string().uuid();

packages/kbn-openapi-common/schemas/primitives.schema.yaml

@@ -0,0 +1,18 @@
+openapi: 3.0.0
+info:
+  title: Shared Primitives Schema
+  version: 'not applicable'
+paths: {}
+components:
+  x-codegen-enabled: true
+  schemas:
+    NonEmptyString:
+      type: string
+      pattern: ^(?! *$).+$
+      minLength: 1
+      description: A string that is not empty and does not contain only whitespace
+
+    UUID:
+      type: string
+      format: uuid
+      description: A universally unique identifier

packages/kbn-openapi-common/scripts/openapi_generate.js

@@ -0,0 +1,22 @@
+/*
+ * 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 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+require('../../../src/setup_node_env');
+const { resolve } = require('path');
+const { generate } = require('@kbn/openapi-generator');
+
+const ROOT = resolve(__dirname, '..');
+
+(async () => {
+  await generate({
+    title: 'OpenAPI Common Schemas (kbn-openapi-common)',
+    rootDir: ROOT,
+    sourceGlob: './schemas/**/*.schema.yaml',
+    templateName: 'zod_operation_schema',
+  });
+})();

packages/kbn-openapi-common/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "outDir": "target/types",
+    "types": ["jest", "node"]
+  },
+  "exclude": ["target/**/*"],
+  "extends": "../../tsconfig.base.json",
+  "include": ["**/*.ts"],
+  "kbn_references": []
+}

packages/kbn-securitysolution-lists-common/README.md

@@ -0,0 +1,20 @@
+# Security Solution Lists common package
+
+The package contains common files for the Lists feature.
+
+`common` in the name highlights that this package is intended to combine any common entities related to Lists in this package. E.g. the other `kbn-securitysolution-list-*` packages
+content should be moved here while `kbn-securitysolution-io-ts-list-types` package should be
+gone eventually.
+
+## API folder
+
+`api` folder contains OpenAPI schemas for Security Solution Lists feature. There are automatically generated Zod schemas and TS types for each schemas located in corresponding
+`*.gen.ts` files.
+
+**Please add any Lists feature related schemas to this package.**
+
+TS types and/or Zod schemas can be imported in a plugin or another package like
+
+```ts
+import { CreateListRequestBody } from '@kbn/securitysolution-lists-common/api';
+```

packages/kbn-securitysolution-lists-common/api/create_list/create_list.gen.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+/*
+ * NOTICE: Do not edit this file manually.
+ * This file is automatically generated by the OpenAPI Generator, @kbn/openapi-generator.
+ *
+ * info:
+ *   title: Create list API endpoint
+ *   version: 2023-10-31
+ */
+
+import { z } from 'zod';
+
+import {
+  ListId,
+  ListName,
+  ListDescription,
+  ListType,
+  ListMetadata,
+} from '../model/list_common.gen';
+import { List } from '../model/list_schemas.gen';
+
+export type CreateListRequestBody = z.infer<typeof CreateListRequestBody>;
+export const CreateListRequestBody = z.object({
+  id: ListId.optional(),
+  name: ListName,
+  description: ListDescription,
+  type: ListType,
+  serializer: z.string().optional(),
+  deserializer: z.string().optional(),
+  meta: ListMetadata.optional(),
+  version: z.number().int().min(1).optional().default(1),
+});
+export type CreateListRequestBodyInput = z.input<typeof CreateListRequestBody>;
+
+export type CreateListResponse = z.infer<typeof CreateListResponse>;
+export const CreateListResponse = List;

packages/kbn-securitysolution-lists-common/api/create_list/create_list.schema.yaml

@@ -0,0 +1,82 @@
+openapi: 3.0.0
+info:
+  title: Create list API endpoint
+  version: '2023-10-31'
+paths:
+  /api/lists:
+    post:
+      x-labels: [serverless, ess]
+      operationId: CreateList
+      x-codegen-enabled: true
+      summary: Creates a list
+      tags:
+        - List API
+      requestBody:
+        description: List's properties
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              properties:
+                id:
+                  $ref: '../model/list_common.schema.yaml#/components/schemas/ListId'
+                name:
+                  $ref: '../model/list_common.schema.yaml#/components/schemas/ListName'
+                description:
+                  $ref: '../model/list_common.schema.yaml#/components/schemas/ListDescription'
+                type:
+                  $ref: '../model/list_common.schema.yaml#/components/schemas/ListType'
+                serializer:
+                  type: string
+                deserializer:
+                  type: string
+                meta:
+                  $ref: '../model/list_common.schema.yaml#/components/schemas/ListMetadata'
+                version:
+                  type: integer
+                  minimum: 1
+                  default: 1
+              required:
+                - name
+                - description
+                - type
+      responses:
+        200:
+          description: Successful response
+          content:
+            application/json:
+              schema:
+                $ref: '../model/list_schemas.schema.yaml#/components/schemas/List'
+        400:
+          description: Invalid input data response
+          content:
+            application/json:
+              schema:
+                oneOf:
+                  - $ref: '../../../kbn-openapi-common/schemas/error_responses.schema.yaml#/components/schemas/PlatformErrorResponse'
+                  - $ref: '../../../kbn-openapi-common/schemas/error_responses.schema.yaml#/components/schemas/SiemErrorResponse'
+        401:
+          description: Unsuccessful authentication response
+          content:
+            application/json:
+              schema:
+                $ref: '../../../kbn-openapi-common/schemas/error_responses.schema.yaml#/components/schemas/PlatformErrorResponse'
+        403:
+          description: Not enough privileges response
+          content:
+            application/json:
+              schema:
+                $ref: '../../../kbn-openapi-common/schemas/error_responses.schema.yaml#/components/schemas/PlatformErrorResponse'
+        409:
+          description: List already exists response
+          content:
+            application/json:
+              schema:
+                $ref: '../../../kbn-openapi-common/schemas/error_responses.schema.yaml#/components/schemas/SiemErrorResponse'
+        500:
+          description: Internal server error response
+          content:
+            application/json:
+              schema:
+                $ref: '../../../kbn-openapi-common/schemas/error_responses.schema.yaml#/components/schemas/SiemErrorResponse'

packages/kbn-securitysolution-lists-common/api/create_list_index/create_list_index.gen.ts

@@ -0,0 +1,23 @@
+/*
+ * 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 and the Server Side Public License, v 1; you may not use this file except
+ * in compliance with, at your election, the Elastic License 2.0 or the Server
+ * Side Public License, v 1.
+ */
+
+/*
+ * NOTICE: Do not edit this file manually.
+ * This file is automatically generated by the OpenAPI Generator, @kbn/openapi-generator.
+ *
+ * info:
+ *   title: Create list DS API endpoint
+ *   version: 2023-10-31
+ */
+
+import { z } from 'zod';
+
+export type CreateListIndexResponse = z.infer<typeof CreateListIndexResponse>;
+export const CreateListIndexResponse = z.object({
+  acknowledged: z.boolean(),
+});