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

[FEATURE REQUEST] Support Parameter formats #8

Open
fmvilas opened this issue Nov 18, 2019 · 2 comments
Open

[FEATURE REQUEST] Support Parameter formats #8

fmvilas opened this issue Nov 18, 2019 · 2 comments
Labels
enhancement New feature or request help wanted Extra attention is needed keep-open

Comments

@fmvilas
Copy link
Member

fmvilas commented Nov 18, 2019

@raveclassic commented on Fri Nov 15 2019

Is your feature request related to a problem? Please describe.
Currently ws channel bindings allow you to define some query/header parameters: https://github.com/asyncapi/bindings/tree/master/websockets#channel-binding-object
However this solution lacks flexibility and power in comparison to swagger-2 or openapi-3 parameters. Especially in case of non-primitive parameters - there's no way to define how such parameters should be serialized. Swagger-2 spec has a collectionFormat and openapi-3 - style/explode for that.

Can't it be tackled using specification extensions?
IMO this should be part of the core spec.

Describe the solution you'd like
The best would be to replicate openapi-3 approach to describe parameters using in/style/explode (etc.) properties.

Describe alternatives you've considered
Not sure there're some which would allow the same level of flexibility and consistency.

Additional context
I'm writing a codegen tool based on swagger-2/openapi-3/asyncapi-2 specs which automatically handles connections that's why I need a solution to fully handle parameters.

@fmvilas
Copy link
Member Author

fmvilas commented Nov 18, 2019

I like the idea of unifying query parameters and headers into a parameters array following the OpenAPI 3 style. However, I would keep this in the WS binding (and maybe HTTP too) for now given that these features only exist in WS and HTTP. There are no other messaging protocols that support query parameters, cookies, etc.

@fmvilas fmvilas added enhancement New feature or request help wanted Extra attention is needed labels Nov 18, 2019
@github-actions
Copy link

This issue has been automatically marked as stale because it has not had recent activity 😴
It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with detailed explanation.
Thank you for your contributions ❤️

@github-actions github-actions bot added the stale label Mar 12, 2020
@fmvilas fmvilas added keep-open and removed stale labels Mar 13, 2020
@github-actions github-actions bot added the stale label Oct 5, 2021
@asyncapi asyncapi deleted a comment from github-actions bot Oct 5, 2021
@derberg derberg removed the stale label Oct 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed keep-open
Projects
None yet
Development

No branches or pull requests

2 participants