elastic/kibana

[OAS] Allow custom sorting/post-processing of OAS properties generated from router

开放

#233,797 创建于 2025年9月2日

 (1 条评论) (0 个反应) (0 位负责人)TypeScript (8,021 个派生)batch import
Feature:OASTeam:Coreenhancementgood first issue

仓库指标

星标
 (19,065 个星标)
PR 合并指标
 (平均合并 1天 16小时) (30 天内合并 999 个 PR)

描述

The OAS converter currently emits properties in the order returned by joi-to-json, with no way to apply custom sorting for user-facing OAS docs.

Current behavior:

  • Properties appear in the order provided by joi-to-json.
  • OpenAPI/OAS has no built-in support for custom field ordering.
  • Modifying the generated YAML is possible but will be overwritten whenever the generator runs.

Possible solutions

  • Add a post-processing hook (similar to postProcessMutations in parse.ts) or an extension point (e.g., ObjectTypeOptionsMeta) so we can reorder properties in the final OAS output (not limited to alphabetical sorting).
  • Alternatively explore safe ways to modify final YAML output without being clobbered by regeneration.
  • Something completely different

References:

Expected outcome:

  • A pluggable mechanism to apply custom sorting or other transformations to generated OAS properties before writing the final spec.

贡献者指南