Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Generate x-model in OpenAPI output #3034

Open
lcawl opened this issue Oct 21, 2024 · 0 comments
Open

Generate x-model in OpenAPI output #3034

lcawl opened this issue Oct 21, 2024 · 0 comments

Comments

@lcawl
Copy link
Contributor

lcawl commented Oct 21, 2024

🚀 Feature Proposal

Our OpenAPI generator should include support for the x-model extension, which is provided in Bump.sh as a way to indicate objects that should be abbreviated (and typically provide externalDocs links to find the information elsewhere).

Motivation

The Elasticsearch specification currently contains deep details about Query DSL, for example, which we'd rather cover in the Query DSL reference. These deep and recursive objects are currently difficult to display in the API docs. Even when there are enhancements in Bump.sh to better handle this type of depth and recursion, we'll likely still want to point elsewhere for this type of language reference.

Example

#3023 contains overlays that apply the x-model extension.
Applying that extension in the specification rather than in overlays will be less fragile to breaking when the spec changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant