Skip to content

Add OpenAPI Extensions support for Route documentation #202

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

Merged
merged 2 commits into from
Jun 18, 2025

Conversation

mciara
Copy link
Contributor

@mciara mciara commented Jun 17, 2025

This PR implements support for OpenAPI Extensions in route documentation, allowing developers to add custom metadata to their API routes.

Usage Example

route.extensions = mapOf(
    "x-custom-extension" to "custom-value",
    "x-another-extension" to mapOf(
        "nested" to "value",
        "number" to 42
    ),
    "x-simple-flag" to true
)

Extensibility
While this PR focuses on adding extensions support to RouteConfig, the OpenAPI specification allows extensions on many other objects. The foundation laid here can be easily extended to other configuration classes (like RequestConfig, ResponseConfig, ParameterConfig, etc.) when needed in the future.

mciara and others added 2 commits June 11, 2025 13:15
Add ability to define custom OpenAPI extensions (x-* fields) in route configuration with support for various data types including nested objects.
@SMILEY4
Copy link
Owner

SMILEY4 commented Jun 18, 2025

Hi @mciara,

Thanks you for the pr. Looks good to me 👍

@SMILEY4 SMILEY4 merged commit 4291a88 into SMILEY4:develop Jun 18, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants