Repository navigation
feat: Adjust documentation in regards of new extension pattern for Store-API route classes - #2551
Merged
Merged
Conversation
Developer Docs healthcheckStatus: Completed with |
Michael Telgmann (mitelg)
force-pushed
the
feat/store-api-extension
branch
3 times, most recently
from
October 29, 2026 10:44
c248b88 to
8c9901c
Compare
…ore-API route classes
Michael Telgmann (mitelg)
force-pushed
the
feat/store-api-extension
branch
from
October 29, 2026 11:49
8c9901c to
a779375
Compare
Michael Telgmann (mitelg)
requested review from
Micha Hobert (Isengo1989),
Bojan Rajh (bojanrajh),
Jonas Elfering (keulinho),
Max Stegmeyer (mstegmeyer) and
Su (sushmangupta)
and
a balanced review from Copilot
October 29, 2026 11:51
Michael Telgmann (mitelg)
marked this pull request as ready for review
October 29, 2026 11:51
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The examples have incompatible HTTP-method and constructor contracts, causing documented POST requests to return 405 and the rate-limiter example to throw a TypeError before reaching the limiter.
2 open issues
What changed in this PR
Updates the Shopware plugin documentation to prefer extension events for Store API routes, while retaining decoration guidance for older versions.
Changes:
- Replaces abstract-route examples with extension classes, dispatcher calls, and event subscribers.
- Aligns service, event-discovery, and rate-limiter guidance with the new route pattern.
- Cleans up Markdown formatting and code-group syntax.
| File | Description |
|---|---|
guides/plugins/plugins/services/adjusting-service.md |
Prefers extension events over service decoration where available |
guides/plugins/plugins/framework/store-api/override-existing-route.md |
Adds subscriber examples and retains legacy decoration guidance |
guides/plugins/plugins/framework/store-api/index.md |
Updates route extensibility principles |
guides/plugins/plugins/framework/store-api/add-store-api-route.md |
Demonstrates extension-based routes and updated dependency injection |
guides/plugins/plugins/framework/rate-limiter/add-rate-limiter-to-api-route.md |
Moves rate-limiter examples into extension-dispatched route bodies |
guides/plugins/plugins/framework/event/finding-events.md |
Distinguishes kernel route events from extension events |
guides/plugins/plugins/framework/caching/index.md |
Cleans up whitespace and code-group formatting |
guides/plugins/plugins/checkout/documents/legacy/add-custom-document-type.md |
Corrects code-group formatting |
Review effort: Balanced
Micha Hobert (Isengo1989)
added
the
Undocumented Feature
Micha Hobert (Isengo1989)
approved these changes
Oct 29, 2026
Micha Hobert (Isengo1989)
left a comment
Micha Hobert (Isengo1989)
left a comment
Contributor
There was a problem hiding this comment.
Thx for the PR Michael Telgmann (@mitelg) 👍
Björn Meyer (BrocksiNet)
approved these changes
Oct 29, 2026
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.
Summary
Adjust certain places of the docs build on the following ADR https://github.com/shopware/shopware/blob/trunk/adr/2026-09-24-replace-abstract-route-classes-with-extension-events.md
Also shopware/shopware#20978 was considered.
Checklist
PageRefreferences where relevant..gitbook.yamlif pages were moved, renamed, or deleted..wordlist.txt(and sorted it) if spellcheck flags new legitimate terms.