[MGNLREST-93] Create new sub-module rest-content-delivery Created: 02/Jun/17  Updated: 25/Sep/17  Resolved: 01/Sep/17

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

Type: Task Priority: Neutral
Reporter: Mikaël Geljić Assignee: Hieu Nguyen Duc
Resolution: Done Votes: 0
Labels: jaxrs, rest
Remaining Estimate: 0d
Time Spent: 15.25d
Original Estimate: 4d

Attachments: XML File config.modules.rest-services.rest-endpoints.delivery.xml     PNG File configuringParams.png     PNG File deliveryConfig.png     PNG File permissions.png     PNG File whitelistingWorkspaces.png    
Issue Links:
Relates
relation
is related to MGNLREST-117 Facilitate operating on subnodes Closed
supersession
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Epic Link: REST Headless bundle
Sprint: Saigon 100, Saigon 101, Saigon 102, Saigon 103, Saigon 104, Saigon 105, Saigon 106, Saigon 107, Saigon 108, Saigon 109, Saigon 110, Saigon 111
Story Points: 5

 Description   
  • only dependencies to standard APIs (JAX-RS, JSON-P)
  • GET only
  • uses the new JCR message body writer (only writer impl needed)
  • new endpoint serving just one node for a given workspace/path
    • no listing of multiple nodes, search, filtering, paging, sorting (follow-up tickets)
  • package proposal: info.magnolia.rest.contentdelivery
    • ContentDeliveryEndpoint v1


 Comments   
Comment by Christopher Zimmermann [ 01/Sep/17 ]

From the wiki page it looks like their are default values for all the properties under the workspace node - so that all i am required to add is a name with the workspace. I hope it is like this. Can you confirm/deny please?

It's a bit of a shame that I need to add JCR configuration to get REST access to a new workspace. But I guess there will be other opportunities once REST endpoints are in a registry. Hmm.

Comment by Christopher Zimmermann [ 01/Sep/17 ]

Could the configuration of the delivery endpoint also then be supplied as an endpoint in the definition registry? Then new modules could add workspaces via decoration. Which would be excellente.

Comment by Mikaël Geljić [ 04/Sep/17 ]

czimmermann Yes there are defaults for the WorkspaceParameters. In particular for node-types, mgnl:content and mgnl:contentNode.

Indeed, once MGNLREST-91 is in, you get the typical benefits from light development: endpoints by YAML, decoration, definitions app. Mind however that there is no default configuration of the delivery endpoint yet; project is providing it (easier than to decorate).
Again, let's see how this evolves with capability of having multiple endpoints backed by the same endpoint class.

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