mirror of
https://github.com/elastic/kibana.git
synced 2025-04-24 17:59:23 -04:00
7a0065d5b6
**Resolves:** https://github.com/elastic/kibana/issues/183821 ## Summary This PR adds missing OpenAPI specifications for Lists API which are the following - `POST /api/lists` - `GET /api/lists` - `PUT /api/lists` - `DELETE /api/lists` - `PATCH /api/lists` - `GET /api/lists/_find` - `GET /api/lists/privileges` - `POST /api/lists/items` - `GET /api/lists/items` - `PUT /api/lists/items` - `DELETE /api/lists/items` - `PATCH /api/lists/items` - `POST /api/lists/items/_export` - `POST /api/lists/items/_import` - `GET /api/lists/items/_find` - `POST /api/lists/index` - `GET /api/lists/index` - `DELETE /api/lists/index` **Note:** Code generation is enabled for the added specs to verify that it works and produces expected results. Generated Zod schemas and types aren't integrated in the route's code. |
||
|---|---|---|
| .. | ||
| api | ||
| scripts | ||
| kibana.jsonc | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
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
import { CreateListRequestBody } from '@kbn/securitysolution-lists-common/api';