-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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
Move swagger-ui under /api/v1 #2746
Conversation
As I said in #2745, for backwards compatibility I'd say it's best to redirect users to /api/swagger when they try to access the org or user on /swagger, and only show the org or user when there actually is one. |
I don't think that it is really usefull to keep a backward compatibility on documentation link. The JSON containing the API specification that could be used by other system hasn't move. Before merging, I forgot to update the link in the footer template. |
yeah, that's true, however my concern is that this pr will effectively 404 all of the current links to /swagger around the web |
@thehowl there should be only in the footer inside gitea itself. I will update other docs links like https://github.com/go-gitea/docs/blob/adef669bcc10c63300692839eb1b57f001777ee2/config.yaml#L34 |
Codecov Report
@@ Coverage Diff @@
## master #2746 +/- ##
=========================================
- Coverage 26.91% 26.9% -0.01%
=========================================
Files 87 88 +1
Lines 17286 17289 +3
=========================================
Hits 4652 4652
- Misses 11955 11958 +3
Partials 679 679
Continue to review full report at Codecov.
|
Is |
@strk yes public vendor is currently managed manually. LGTM |
@strk I have added the task in the makefile for easing the process but it is better to keep it under manual update since there is also a template (serve under /api(/v1)/swagger) manually derivated from index.html to work under that url. Doing it manually also ensure that the specs at still working with the swagger-ui display. For information, You can also open the swagger-ui interface directly via /vendor/assets/swagger-ui/index.html and it will load the specs but that's not a pretty url ^^. |
Make LG-TM work again |
Fix #2745 & update swagger-ui version