Skip to content

[Security Solution] Provide an utility to merge domain-specific OpenAPI bundles with the other Kibana bundles #186356

@maximpn

Description

@maximpn

Epic: https://github.com/elastic/security-team/issues/9401 (internal)

Summary

Provide an utility to merge Security Solution domain-specific bundles stored in /x-pack/plugins/security_solution/docs/openapi and OpenAPI packages with Kibana-wide bundles stored in /oas_docs. As a result, we should have two final bundles:

  • 1st one is for all Kibana API endpoints available in ESS, for all API versions.
  • 2nd one is for all Kibana API endpoints available in Serverless, for all API versions.

As the next step, we (Kibana Core, most likely) will need to set up a CI/CD pipeline for deploying these two bundles to bump.sh.

Details

kbn-openapi-bundler is capable of merging OpenAPI specs as a part of the bundling process. It should be modified to expose the merger functionality.

To do

  • Expose merge utility function form kbn-openapi-bundler package (implemented in PR)
  • Allow to specify multiple glob patterns for convenient configuration (implemented in PR)
  • Support OpenAPI specs in JSON format (implemented in PR)
  • Handle merging errors (implemented in PR)

Metadata

Metadata

Assignees

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions