[MGNLREST-167] mgnl:tags should be returned even when includeSystemProperties is false Created: 17/Jan/18  Updated: 10/Feb/20  Resolved: 17/Sep/19

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

Type: Improvement Priority: Neutral
Reporter: Christopher Zimmermann Assignee: Robert Šiška
Resolution: Outdated Votes: 1
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Relates
relates to MGNLREST-209 DOC: Describe RESTv2 systemProperties... Closed
dependency
depends upon MGNLREST-140 Provide more fine-grained inclusion o... Closed
relation
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:
Epic Link: SPA Editor
Sprint: SPA Editor 4, SPA Editor 5, SPA Editor 6
Story Points: 2

 Description   

Content tags are a part of the standard part of a content item and should be returned even when includeSystemProperties is false.

 

Resolution:

Developers can use MGNLREST-140 to specify which systemProperties they want included.



 Comments   
Comment by Christopher Zimmermann [ 09/Sep/19 ]

I see the related MGNLREST-140 ticket. However, ideally a developer should not have to explicitly request the "mgnl:tags" field using the mechanism in that ticket. It should be included by default, it is not a system property - even though it is prefixed "mgnl:".

Lets discuss! Because I can also see that the above introduces some kind of inconsistancy. What I want to prevent is that every rest endpoint declaration has to include:

systemProperties:

  • mgnl:tags
Comment by Robert Šiška [ 13/Sep/19 ]

czimmermann

The only way I see that makes sense would be to allow all "mgnl:*" properties by default. Treating only mgnl:tags (only present in ee, btw) differently would make no sense in rest module.

Comment by Christopher Zimmermann [ 13/Sep/19 ]

No, wouldn't want to do that.

Comment by Christopher Zimmermann [ 17/Sep/19 ]

We agreed via a Slack discussion that this is solved by enabling developers to configure which systemProperties are delivered via the new  MGNLREST-140 feature. It's a bit sad that developers must configure this, but its not that hard and rest endpoints are not created that often - also it would be somehow confusing and inconsistant if the mgnl:tags property was automatically included but the other mgnl properties were not.

If this is not satisfactory with customers and partners we can re-evaluate this in the future.

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