[MGNLREST-334] Get versioned content with "delivery" path, not "preview" path Created: 08/Nov/21  Updated: 25/Apr/23  Resolved: 03/Jun/22

Status: Closed
Project: Magnolia REST Framework
Component/s: None
Affects Version/s: None
Fix Version/s: 3.0.0, 2.2.14

Type: Improvement Priority: Neutral
Reporter: Christopher Zimmermann Assignee: Phong Le Quoc
Resolution: Done Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: 3d 7.25h Time Spent: 3d 7.25h
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Issue Links:
Problem/Incident
is caused by MGNLREST-280 The Versions/Compare versions feature... Closed
Relates
documentation
to be documented by MGNLREST-413 DOC: Uses delivery endpoint (any name... Closed
Sub-Tasks:
Key
Summary
Type
Status
Assignee
MGNLREST-399 Implement to deprecate preview endpoint Sub-task Completed Phong Le Quoc  
MGNLREST-400 Review rest module Sub-task Completed Jaroslav Simak  
MGNLREST-401 PiQA Sub-task Completed Chuong Doan Huy  
MGNLREST-402 QA Sub-task Completed Canh Nguyen  
MGNLREST-404 Implement minimal-headless-spa-demos Sub-task Completed Phong Le Quoc  
MGNLREST-405 Implement hello-saas Sub-task Completed Phong Le Quoc  
MGNLREST-406 Implement frontend-helpers Sub-task Completed Phong Le Quoc  
MGNLREST-412 Review minimal-headless-spa-demos Sub-task Completed Bartosz Staryga  
Template:
Acceptance criteria:
Empty
Task DoD:
[X]* Doc/release notes changes? Comment present?
[X]* Downstream builds green?
[X]* Solution information and context easily available?
[X]* Tests
[X]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Date of First Response:
Epic Link: SPA Editor Backlog
Sprint: DevX 11
Story Points: 3

 Description   

The "preview" endpoint path (added in https://jira.magnolia-cms.com/browse/MGNLREST-280) introduces confusion as it does not provide a preview but rather a version of the content. Preview in the Magnolia context typically means viewing content before it has been published.

It's also unneccessary complexity to add an additional endpoint "preview" when adding a version querystring is sufficient.

Acceptance criteria:

  • Deprecate support for "preview".
  • Developers caan retrieve a version of the content simply by using the existing delivery endpoint path but adding a "version" querystring parameter.
  • Update demo projects
  • Update documentation

Generated at Mon Feb 12 06:58:54 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.