Add support for recursive schemas #182910
Labels
Feature:http
Feature:OAS
Work or issues related to Core-provided mechanisms for generating OAS
Team:Core
Core services & architecture: plugins, logging, config, saved objects, http, ES client, i18n, etc
Comments
jloleysens
added
Feature:http
Team:Core
jloleysens
added a commit
that referenced
this issue
May 23, 2024
## Summary Close #182910 Add the ability to declare recursive schemas. Updates `@kbn/config-schema` to support recursive types. This design follows the underlying pattern provided by Joi: https://joi.dev/api/?v=17.13.0#linkref: ```ts const id = 'recursive'; const recursiveSchema: Type<RecursiveType> = schema.object( { name: schema.string(), self: schema.lazy<RecursiveType>(id), }, { meta: { id } } ); ``` Since using the `.link` API we are also using `.id` which enables us to leverage this mechanism OOTB with `joi-to-json` for OAS generation (thus we could delete a lot of code there). I chose to avoid using `id` originally because I thought it would be simpler if we control more of the conversion in config-schema's case but for recursive schemas and references I think this is a favourable trade off. Open to other ideas! --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
rshen91
pushed a commit
to rshen91/kibana
that referenced
this issue
May 30, 2024
## Summary Close elastic#182910 Add the ability to declare recursive schemas. Updates `@kbn/config-schema` to support recursive types. This design follows the underlying pattern provided by Joi: https://joi.dev/api/?v=17.13.0#linkref: ```ts const id = 'recursive'; const recursiveSchema: Type<RecursiveType> = schema.object( { name: schema.string(), self: schema.lazy<RecursiveType>(id), }, { meta: { id } } ); ``` Since using the `.link` API we are also using `.id` which enables us to leverage this mechanism OOTB with `joi-to-json` for OAS generation (thus we could delete a lot of code there). I chose to avoid using `id` originally because I thought it would be simpler if we control more of the conversion in config-schema's case but for recursive schemas and references I think this is a favourable trade off. Open to other ideas! --------- Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
No description provided.
The text was updated successfully, but these errors were encountered: