mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 03:01:21 -04:00
cebcf01d35
## Summary Resolves https://github.com/elastic/security-docs-internal/issues/49. In order to retire asciidoc API docs, we first need to move over any relevant content from those docs to the API reference site. This PR adds the relevant conceptual information from: - https://www.elastic.co/guide/en/security/master/exceptions-api-overview.html - https://www.elastic.co/guide/en/security/master/lists-api-overview.html - https://www.elastic.co/guide/en/security/master/rule-api-overview.html ### Previews: Bump previews expire after 30min, so I'm providing screenshots below: Detections preview:  Exceptions preview:  Lists preview:  --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| api | ||
| docs/openapi | ||
| 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';