[MGNLREST-522] Specify Norsu endpoint without Java classes Created: 14/Oct/22  Updated: 08/May/23  Resolved: 27/Oct/22

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

Type: Story Priority: Neutral
Reporter: Christopher Zimmermann Assignee: Canh Nguyen
Resolution: Done Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: 1d 3.5h Time Spent: 1.25d
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Issue Links:
Relates
relates to MGNLREST-517 Specify delivery endpoint version in ... Closed
relates to MGNLREST-529 DOC: How to collectively refer to Del... Closed
relates to MGNLREST-684 Support annotation for DeliveryEndpo... Closed
documentation
to be documented by MGNLREST-543 DOC: Specify endpoint types without J... Closed
Sub-Tasks:
Key
Summary
Type
Status
Assignee
MGNLREST-530 Implement Sub-task Completed Canh Nguyen  
MGNLREST-531 Review Sub-task Completed Oanh Thai Hoang  
MGNLREST-532 piQA Sub-task Completed Oanh Thai Hoang  
MGNLREST-533 QA Sub-task Completed Phong Le Quoc  
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)
Release notes required:
Yes
Documentation update required:
Yes
Epic Link: Norsu delivery endpoint (phase 1)
Sprint: DevX 22
Story Points: 1
Team: DeveloperX

 Description   

As a developer I want to define a Norsu endpoint without referring to any Java classes.

Last time I checked, to define a Norsu delivery endpoint, the definition required 2 different Java classes. We cannot use Java classes in any SaaS configuration. 

Also do not provide a default class, as we want developers to specify a specific endpoint implementation so that their projects wil continue to work even if we introduced a new version of the endpoint with non-backwards compatible aspects.

Standard magnolia way would be to provide at `$type` mapping for the main class.

But consider if want to pursue a different pattern, such as specifying a 'version' and in that case their could be a default class or implementation.

See: https://jira.magnolia-cms.com/browse/MGNLREST-517

 

Sample yaml config for norsu 

$type: deliveryEndpoint_v2 

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