elastic/kibana

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

Open

#233797 opened on Sep 2, 2025

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (19,065 stars) (8,021 forks)batch import
Feature:OASTeam:Coreenhancementgood first issue

Description

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.

Contributor guide

Tech stack
typescriptnodejsrest api
Domain
backendapi
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScriptOpenAPI SpecificationKibana codebase navigation
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Examine the postProcessMutations hook in parse.ts (https://github.com/elastic/kibana/blob/6f6a42d492aea851c3aaf68830e667491a4660fe/src/platform/packages/shared/kbn router to openapispec/src/oas converter/kbn config schema/parse.ts#L38 L52) to understand its pattern. Investigate how OAS properties are currently generated from joi to json and identify where a custom sorting/post processing hook could be inserted. Propose a design for a pluggable mechanism, possibly using a function or class that receives the generated spec and allows transformations. Consider edge cases like preserving order for required fields or handling nested properties. No implementation needed; focus on design and identifying potential extension points.