[MGNLREST-140] Provide more fine-grained inclusion of system properties Created: 31/Oct/17  Updated: 24/Sep/19  Resolved: 24/Sep/19

Status: Closed
Project: Magnolia REST Framework
Component/s: delivery
Affects Version/s: None
Fix Version/s: 2.1.3

Type: Improvement Priority: Neutral
Reporter: Mikaël Geljić Assignee: Robert Šiška
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
causality
is causing MGNLREST-209 DOC: Describe RESTv2 systemProperties... Closed
dependency
is depended upon by MGNLREST-167 mgnl:tags should be returned even whe... Closed
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)
Documentation update required:
Yes
Date of First Response:
Epic Link: SPA Editor
Sprint: SPA Editor 5, SPA Editor 6
Story Points: 5

 Description   

Implement a default strategy that includes selected mgnl properties (tags mostly); this strategy should be swappable by configuration.

Other policies could be implemented to white-list specific properties, or include more jcr/mgnl-prefixed ones.

few examples:

  • keeping mgnl: props but not jcr: ones
  • specifying mgnl sys props to include by mixins
  • what to do for other domain-ish content (mgnl:template or mgnl:type for blocks)
  • give flexibility via query-params?

we could/would probably complement that with separate @nodeTypes and @id special properties.



 Comments   
Comment by Christopher Zimmermann [ 20/Nov/17 ]

Note https://jira.magnolia-cms.com/browse/MGNLREST-136 brings in @id and @nodeType properties.

Comment by Mikaël Geljić [ 08/Mar/18 ]

Here's my copy/pasta as well

 

that owes to the project setup; IRL content is [seldom] created by [superuser]
I would file a ticket in MGNLDEMO to update createdBy & lastModifiedBy to actual authors of that project (tina or whoever that is)

These mgnl properties are mostly legit metadata imo, they're part of the content—we can think about mgnl:tags as well. I'm indeed less convinced about the jcr: properties which I would really consider system properties—and which are redundant with our "special" properties (e.g. @id, @nodeType). Lastly, (mgnl) versioning and activation properties are more debatable.

Generally, my intention here is to provide a set of reasonable defaults to choose from.

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