WIP(swagger-ui): Upgrade to v3 #209
Conversation
|
Great stuff, @STRML! Let us know when the pull request is ready for review. |
|
Will do. We'll want to wait a few weeks for Swagger-UI v3 to stabilize. Minor releases are still shipping some pretty fundamental bugfixes. But after that, it should be quite nice. |
- typo fix in side menu - intro text taks about publishing flow - API link to the internal docs (explained) - removed datastore link as does not belong there Note: that exact Links for the API docs are not yet there as Swagger 3.0 Do not support shebang URLs at this moment. There is an existing PR for this and hopefully will be fixed soon strongloop/loopback-component-explorer#209
|
Hi everyone! Jumping in from Swagger-land to share some good news....
In 3.0.7 we started maintaining a |
|
@STRML ping, what's the status of this pull request? Has Swagger-UI v3 stabilized yet? |
|
Hey @STRML, what's the status of this pull request? Are you still keen to get it finished? Should we close it as abandoned? |
|
Hey - I definitely want to get this through, had really just gotten busy and forgotten about it, and the earlier Now that it's resolved I'm going to take another look today and push up something mergeable. |
STRML
force-pushed
the
feature/swagger-ui-3
branch
2 times, most recently
from
9efe75f
to
731b5f0
Compare
|
Ok, the latest push gets us to a working setup, and we're much more in-line with base Swagger-UI (fewer customizations). Swagger-UI 3 has a lot more customizability than previous versions, so I've added the ability to write options to
Syntax highlighting is partially in (microlight is running) but it's very limited (swagger-api/swagger-ui#3189). Additionally, Authorization is an issue. We're going to require strongloop/loopback-swagger#65 be fixed (
|
STRML
force-pushed
the
feature/swagger-ui-3
branch
from
731b5f0
to
57713bb
Compare
|
@STRML thank you for the update, looks like there is quite a lot of work needed to make this happen. From custom style to authorization support. Do you have bandwidth to implement these changes? |
|
Not particularly, across all projects. If you guys can find some help to do the rest of the work on loopback-swagger such that we have all the fields we need, I can finish the rest here. |
|
I might also be able to help out, if there are some marked-off tasks that are good for contribution. |
|
@sebastianhaas thank you for the offer. Could you perhaps take a look at strongloop/loopback-swagger#65? I think that's the biggest blocker right now. |
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
|
Your stale bot is very annoying. |
|
Any news about this upgrade ? Thanks for your awesome work ! |
|
strongloop/loopback-swagger#65 is a blocker. |
|
Just a status report: nothing has really changed since #209 (comment) - swagger-ui still has the missing syntax highlight features and threshold, and we still need to properly export authSchema to move forward with authorization (which would be a pretty major regression blocking release). |
|
Thank you for the update, @STRML. The main focus of the IBM team is on LoopBack 4 now, we don't have bandwidth to help with upgrading swagger-ui to v3 and/or improving loopback-swagger to correctly export authSchema. We are relying on the community to drive the progress here. |
|
This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. |
|
This issue has been closed due to continued inactivity. Thank you for your understanding. If you believe this to be in error, please contact one of the code owners, listed in the |
FWIW, we are successfully using https://www.npmjs.com/package/swagger-ui-dist in the upcoming 4.0 version of LoopBack. |
- typo fix in side menu - intro text taks about publishing flow - API link to the internal docs (explained) - removed datastore link as does not belong there Note: that exact Links for the API docs are not yet there as Swagger 3.0 Do not support shebang URLs at this moment. There is an existing PR for this and hopefully will be fixed soon strongloop/loopback-component-explorer#209
This is a work in progress; please don't merge yet.
V3 brings with it some major changes. Most of the changes are great.
Issues blocking release in loopback-component-explorer:
The npm package no longer exports a bundle. I'm not sure if this is intentional. For this reason, I've added a dev-only script to copy from github releases.