[DOCU-1366] Update "Getting started with REST" Created: 13/Mar/18  Updated: 29/Mar/18  Resolved: 28/Mar/18

Status: Closed
Project: Documentation
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Christoph Meier Assignee: Julie Legendre
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
causality
is causing DOCU-1393 Publish related doc for 5.6.4 Closed
Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:
Account:
Sprint: Docu Sprint 46
Story Points: 3

 Description   

Update Getting started with REST

Minimal changes
Make sure all examples refer to REST-2.1, delivery ep. def v2

New things
Add examples with:
localized content, image ref. resoving, image renditions

Challenge
When REST 2.1 gets deployed, there will be not bundle containing REST-2.1,
hence the bundle or webapp must be customized :-|



 Comments   
Comment by Julie Legendre [ 22/Mar/18 ]

Copy here: https://documentation.magnolia-cms.com/display/DOCS56/Getting+started+with+REST+v2.1

Comment by Christoph Meier [ 22/Mar/18 ]

W have decided to prepare the updated version for this tuto for the release of Magnolia 5.6.4 - which will contain REST-2.1 - as well as a tourFinder definition.

Comment by Christoph Meier [ 26/Mar/18 ]

The new e.p. definitions are not yet on a bundle as far as I know - however, we already know how they will look like.
=> See https://git.magnolia-cms.com/projects/MODULES/repos/demo-projects/browse/community/magnolia-travel-tours/src/main/resources/tours/restEndpoints/delivery

These v2. delivery e.p. defs. (see link above) are made in a way, that "old" URLs also will work with these new definitions - which is great!
However - we probably should explain this on the "Getting started ..." (not sure).

5.6.4-SNAPSHOT already contains these changes.

Comment by Julie Legendre [ 27/Mar/18 ]

cmeier please review: https://documentation.magnolia-cms.com/display/DOCS56/Getting+started+with+REST+v2.1

And test this statement:
You can request the first URL, which goes to the public instance, with the browser as the anonymous user (without authentication). For the second URL, you must authenticate.

Comment by Christoph Meier [ 28/Mar/18 ]

jlegendre - reviewed.
Now there are 3 remaining inline comments. (There have been others too ... but those were "wrong").

I set to in progress again. At least 3 things should be fixed. Feel free to contact me.

Comment by Julie Legendre [ 28/Mar/18 ]

Feedback integrated, please take another look cmeier

Comment by Christoph Meier [ 29/Mar/18 ]

OK. Fine now jlegendre

Let's publish when Magnolia 5.6.4 has been released.

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