Repository navigation
[docs] Document the Batcher and CacheKey features - #1728
Open
andrewnicols wants to merge 1 commit into
Open
andrewnicols wants to merge 1 commit into
andrewnicols wants to merge 1 commit into
Conversation
andrewnicols
added
the
blocked-by-tracker
✅ Deploy Preview for moodledevdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The documented URLs and minimum-version guidance need correction before developers can reliably use the examples.
3 open findings
What changed in this PR
Adds developer guides for request batching and cacheable routes in Moodle’s REST API.
Changes:
- Documents automatic and manual
core/fetchbatching. - Explains route cache lifetimes, cache keys, headers, and batching interactions.
| File | Description |
|---|---|
| docs/guides/javascript/ajax/batcher.md | Explains batching usage and configuration. |
| docs/apis/subsystems/routing/caching.md | Documents cacheable routes and JavaScript requests. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| - Performance | ||
| --- | ||
|
|
||
| <Since version="6.0" issueNumber="MDL-82652" /> |
|
|
||
| ```php title="A cacheable route" | ||
| #[\core\router\route( | ||
| path: '/strings/{language}/{component}[/{identifier:.*}]', |
Comment on lines
+41
to
+42
| /api/rest/v2/strings/en/core # No cache key - not cached | ||
| /api/rest/v2/cachekey:1737584047/strings/en/core # Cacheable |
This branch has not been deployed
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
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.
MDL-82652