[MGNLREST-223] DOC: Best practice is to put delivery endpoints under /delivery path. Created: 05/Feb/20 Updated: 18/Feb/20 Resolved: 18/Feb/20 |
|
| Status: | Closed |
| Project: | Magnolia REST Framework |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | None |
| Type: | Improvement | Priority: | Major |
| Reporter: | Christopher Zimmermann | Assignee: | Martin Drápela |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Template: |
|
| Acceptance criteria: |
Empty
|
| Task DoD: |
[ ]*
Doc/release notes changes? Comment present?
[ ]*
Downstream builds green?
[ ]*
Solution information and context easily available?
[ ]*
Tests
[ ]*
FixVersion filled and not yet released
[ ] 
Architecture Decision Record (ADR)
|
| Date of First Response: | |
| Sprint: | 6.2 Ramp-up 16 |
| Story Points: | 1 |
| Description |
|
All examples in docs should put delivery endpoints under the /delivery directory - ie /restEndpoints/delivery
This makes it clear what the rest endpoint is doing, and it makes them easier to use because the default role 'rest-anonymous' is already configured to allow web access to the path '.rest/delivery/*'.
So if you dont use the '/delivery' path, then you have to do extra configuration.
Also document security configuration necessary to get content as an anonymous user. |