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: fix swagger.json #891

Merged
merged 1 commit into from
Dec 5, 2023
Merged

Conversation

iambocai
Copy link
Contributor

@iambocai iambocai commented Nov 24, 2023

Description of your changes

  • Update swagger.json by make build-swagger.
  • Returns a predefined structure instead of a map object to avoid Swagger being unable to generate code correctly
  • Delete duplicate runtimes_cluster parameter definition to avoid the code constructed by swagger being unusable
  • Add swagger 3.0.json to facilitate developers debugging APIs on the swagger UI (BearerAuth only available in swagger 3.0+).
    image

Fixes #713

I have:

  • Read and followed KubeVela's contribution process.
  • Related Docs updated properly. In a new feature or configuration option, an update to the documentation is necessary.
  • Run yarn lint to ensure the frontend changes are ready for review.
  • Run make reviewableto ensure the server changes are ready for review.
  • Added backport release-x.y labels to auto-backport this PR if necessary.

Special notes for your reviewer

* Update swagger.json by `make update-swagger`.
* Returns a predefined structure instead of a map object to avoid Swagger being unable to generate code correctly
* Delete duplicate runtimes_cluster parameter definition to avoid the code constructed by swagger being unusable
* Add swagger 3.0.json to facilitate developers debugging APIs on the swagger UI.

Signed-off-by: 上郡 <[email protected]>
Copy link

codecov bot commented Nov 24, 2023

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (2ab672c) 59.01% compared to head (8e1d491) 32.75%.

Files Patch % Lines
pkg/server/interfaces/api/plugin.go 0.00% 1 Missing ⚠️
pkg/server/interfaces/api/repository.go 0.00% 1 Missing ⚠️
Additional details and impacted files
@@             Coverage Diff             @@
##             main     #891       +/-   ##
===========================================
- Coverage   59.01%   32.75%   -26.27%     
===========================================
  Files         116       91       -25     
  Lines       19846    17940     -1906     
===========================================
- Hits        11713     5877     -5836     
- Misses       6696    11189     +4493     
+ Partials     1437      874      -563     
Flag Coverage Δ
apiserver-unittests 32.75% <0.00%> (+0.13%) ⬆️
server-e2e-tests ?

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@wonderflow wonderflow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good job

@wonderflow wonderflow merged commit 127f532 into kubevela:main Dec 5, 2023
12 of 16 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.

Kubevela OpenAPI/Swagger client generation failure
2 participants