Conversation
- Use Redoc instead of swagger - Don't rely on CDN - Fix docs for bulk_search API Signed-off-by: Shivam Sandbhor <[email protected]>
|
Just curious: what's the rationale for selecting redoc? |
|
Redoc comes from :
To get the code in a script, first get the JSON api at https://registry.npmjs.org/redoc This is overall a messy provenance and therefore license. |
|
This could be a better source than the npm package https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js and this is also messy license. |
|
Steps to take about licensing after merging this PR: #549 |
|
Hi, I watched this a bit from the sidelines and I have to admit I'm a bit puzzled. Maybe I have been too imprecise in my statements.
You then partially did what I recommended; ingesting the distribution builds into your static folder. So far so good. However, instead of simply setting The whole point of spectacular is not having stale, outdated hard-coded API specifications. This kind of defeats the purpose of the whole thing but I digress. But on a lighter note, we just added your request: https://github.com/tfranzel/drf-spectacular#self-contained-ui-installation This installs https://github.com/tfranzel/drf-spectacular-sidecar, which is an optional package containing all those assets. The package sources from jsdelivr and releases a PyPi package containing those static files. Basically what you did in this PR. Just some food for thought. Have a good day! |
|
@tfranzel FYI, I am working to reinstate drf-spectacular with swagger which is much better than a plain redoc and this before we are effectively going public :) |
Fixes #454 , #446
Signed-off-by: Shivam Sandbhor [email protected]