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

fix(dashboard): fix swagger spec generation #9997

Merged
merged 1 commit into from Feb 24, 2023

Conversation

savonarola
Copy link
Contributor

@savonarola savonarola commented Feb 18, 2023

Swagger says deprecated metadata field should always be boolean https://swagger.io/specification/

But in hocon we also support values like{since, "4.3.0"}, which result in "deprecated": "since(\"4.3.0\")" metadata.
This incompatibility breaks some API client generators.

@savonarola savonarola marked this pull request as ready for review February 20, 2023 11:31
@savonarola savonarola requested review from a team, JimMoen and lafirest as code owners February 20, 2023 11:31
changes/ce/fix-9997.zh.md Outdated Show resolved Hide resolved
@lafirest
Copy link
Member

I have a question, after this PR how could we tell users one API have been deprecated from a certain version?

@savonarola
Copy link
Contributor Author

savonarola commented Feb 23, 2023

how could we tell users one API have been deprecated from a certain version

We may add this info to the desc somehow...
However, seems that openapi schema does not intend to expose this kind of information at all

@savonarola savonarola force-pushed the fix-swagger-spec-gen branch 4 times, most recently from b063864 to 4373bd0 Compare February 23, 2023 18:17
@zmstone zmstone merged commit 812a878 into emqx:master Feb 24, 2023
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.

None yet

3 participants