[PAGES-942] [Norsu] Remove workspace from template annotation endpoint Created: 28/Nov/22  Updated: 17/Feb/23  Resolved: 16/Dec/22

Status: Closed
Project: Magnolia pages module
Component/s: None
Affects Version/s: None
Fix Version/s: 6.3.0

Type: Improvement Priority: Neutral
Reporter: Robert Šiška Assignee: Phong Le Quoc
Resolution: Fixed Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: 15d 1h Time Spent: 15d 1h
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Issue Links:
Problem/Incident
causes PAGES-969 Prefix the paths in events sent by ex... Closed
relation
is related to PAGES-971 [Norsu] Add unittest for Norsu's Temp... Closed
is related to MGNLREST-537 [Norsu] Remove workspace and root pat... Closed
Sub-Tasks:
Key
Summary
Type
Status
Assignee
PAGES-960 Implement Sub-task Completed Phong Le Quoc  
PAGES-961 Review Sub-task Completed Canh Nguyen  
PAGES-962 PiQA Sub-task Completed Canh Nguyen  
PAGES-963 QA Sub-task Completed Robert Šiška  
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: Norsu delivery endpoint (phase 1)
Sprint: DevX 25, DevX 26
Story Points: 2
Team: DeveloperX
Work Started:

 Description   

Since we're removing the workspace from the delivery endpoint, we should also remove it from the norsu template annotation endpoint.

 

Currently, it requires the workspace in the URL and returns it in the response, which requires adding/removing the workspace on the client-side.



 Comments   
Comment by Canh Nguyen [ 01/Dec/22 ]
{
  "/website/react-minimal/extras": "cms:area content=\"/website/react-minimal/extras\" name=\"extras\" availableComponents=\"spa-lm:components/headline,spa-lm:components/paragraph,spa-lm:components/list\" type=\"list\" dialog=\"null\" label=\"extras\" inherit=\"false\" optional=\"false\" createAreaNode=\"true\" showAddButton=\"true\" showNewComponentArea=\"false\" activationStatus=\"2\" ",
  "/website/react-minimal": "cms:page content=\"/website/react-minimal\" dialog=\"spa-lm:pages/basic\" ",
  "/website/react-minimal/main": "cms:area content=\"/website/react-minimal/main\" name=\"main\" availableComponents=\"spa-lm:components/headline,spa-lm:components/image,spa-lm:components/paragraph,spa-lm:components/expander,spa-lm:components/list\" type=\"list\" dialog=\"null\" label=\"main\" inherit=\"false\" optional=\"false\" createAreaNode=\"true\" showAddButton=\"true\" showNewComponentArea=\"false\" activationStatus=\"2\" "
}

We should remove "/website" from the template annotations' response. Frontend helpers map paths from delivery endpoint data wit paths from template annotations.

Comment by Christopher Zimmermann [ 09/Dec/22 ]

I think there is a both a JCR and a Norsu version of template endpoints. Here I think we are only talking about the Norsu version.

Please keep the Norsu one consistant with the JCR one.

But keep in mind that there are sort of two cases.

  • When a developer defines a templateAnnotations endpoint themselves.
  • The templateAnnotations endpoint that is automatically provisioned by the system.

(Sorry if this is different from what we discussed in the DevX Dailly on Thursday, where I think we said "workspace" property is mandatory. )

Keep in mind that for the near future, on SaaS - developers will not actually be defining templateAnnotations endpoints themselves, they will use the default provided one because the whole system is not yet flexible enough to support multiple pages apps. 

Comment by Christopher Zimmermann [ 12/Dec/22 ]

plequoc So no obstacles here right? Can we remove the "flag" that makes the card yellow?

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