elastic / kibana

Your window into the Elastic Stack
https://www.elastic.co/products/kibana
Other
19.68k stars 8.23k forks source link

[ResponseOps][Cases] OAS specification in the Cases public APIs #197606

Open cnasikas opened 1 month ago

cnasikas commented 1 month ago

The Core team added support for OAS in the Kibana routes. To provide users with an up-to-date OAS for the documented public Cases API we need to register the OAS schema on each public route. Cases routes are versioned but they use io-ts for schema validation. The Kibana router does not support io-ts for OAS generation. Based on https://github.com/elastic/kibana/pull/186190, they added support for zod. Based on an analysis we did in the past, we concluded that zod would be a good fit for Cases schema. To be able to support OAS in the Cases public APIs we need to convert our schemas to zod and then register the schema on our routes.

Requirements:

API routes

elasticmachine commented 1 month ago

Pinging @elastic/response-ops-cases (Feature:Cases)