New: add endpoints to fetch content plugin READMEs (fixes #100)#101
Merged
Conversation
|
🎉 This PR is included in version 1.8.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #100
New
GET /api/contentplugins/readmereturning every installed plugin's README.md as an object keyed by plugin name.GET /api/contentplugins/:_id/readmereturning a single plugin's{ name, readme }, looked up by_id(404s if the plugin or its README is absent).getPluginReadmesutil (globs the framework src for{components,extensions,menu,theme}/*/README.md) and agetReadmes()method.Testing
npm test— includes newtests/utils-getPluginReadmes.spec.js.GET /api/contentplugins/readmereturns a name→markdown map.GET /api/contentplugins/<_id>/readmereturns{ name, readme }.