pleroma/api-docs
0
0
Fork 0
Code Issues 2 Pull requests Projects Releases Packages Wiki Activity

Alternative to ReDoc? #3

New issue
Open
opened 2023-07-04 03:31:02 +00:00 by lanodan · 1 comment
lanodan commented 2023-07-04 03:31:02 +00:00
Owner
Copy link

I noticed that we hadn't updated redoc in 2+ years, but it turns out to hard-depend on their CDN (cdn.redoc.ly) to serve the hard-required JavaScript (none of the sidebar sections work, none of the details/spoilers of examples open, …), with nothing like Subressource-Integrity of course.

The only way to fix it ourselves would be to monkey-patch node_modules/@redocly/cli/lib/commands/build-docs/utils.js.

Given the reaction on https://github.com/Redocly/redoc/issues/2141, I doubt this is going to change.

List of OpenAPI documentation tools: https://tools.openapis.org/categories/documentation.html

I noticed that we hadn't updated redoc in 2+ years, but it turns out to hard-depend on *their* CDN (`cdn.redoc.ly`) to serve the hard-required JavaScript (none of the sidebar sections work, none of the details/spoilers of examples open, …), with nothing like Subressource-Integrity of course. The only way to fix it ourselves would be to monkey-patch `node_modules/@redocly/cli/lib/commands/build-docs/utils.js`. Given the reaction on <https://github.com/Redocly/redoc/issues/2141>, I doubt this is going to change. List of OpenAPI documentation tools: <https://tools.openapis.org/categories/documentation.html>
seanking commented 2023-12-13 19:03:13 +00:00
Member
Copy link

It's sad really. Plenty of folks opposed using that external CDN for the ReDoc logo. Yet, the folks at ReDoc refused to revert that decision because "muh branding". Just make a new minor version if you really desire folks to update it. Better yet, make it easier (or better yet, hold public trainings on how) to update to the newest version.

It's sad really. Plenty of folks opposed using that external CDN for the ReDoc logo. Yet, the folks at ReDoc refused to revert that decision because "muh branding". Just make a new minor version if you really desire folks to update it. Better yet, make it easier (or better yet, hold public trainings on how) to update to the newest version.
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
gitlab-mr-iid-1
No results found.
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
pleroma/api-docs#3
No description provided.