[DOCU-1188] Getting started with Magnolia REST tutorial Created: 17/Oct/17  Updated: 06/Nov/17  Resolved: 03/Nov/17

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

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

Template:
Acceptance criteria:
Empty
Date of First Response:
Epic Link: Reflect REST 2.0 updates
Sprint: Docu Sprint 36
Story Points: 8

 Description   

A (REST) beginners tutorial.
Giving a "full service guide" from installing to a very small usage example
New page - however, some content can be reused from My first REST request and maybe REST API.

Possible TOC

Setup
Installing the modules (link to modules page)
Security settings
Testing the setup

Getting familiar with the tools
swagger tools (incldung setting the apiBasepath property)
cURL
others: we may provide a little static HTML which can be served from magnolia to send request to the endpoints

The endpoints - an overview
nodes and properties: Can do GET, PUT, POST and DELETE
delivery: GET only (atm)
Comparision (not sure about this ...)

My first REST requests
via cURL (or the little static HTML - if build)
Further reading, next steps
link to Accessing content on the client side, API docs, ...



 Comments   
Comment by Christoph Meier [ 02/Nov/17 ]

Here is my 1st version of what I had in mind when writing this JIRA ticket:
https://documentation.magnolia-cms.com/display/DOCS56/Getting+started+with+REST

We may add further REST calls (with cURL).

And we even may add a more practical use case. To the same page or as 2nd page / sub page.

However - I thought it is about getting started ... which ... I hope ... is provided with the current given content.

It even contains a "Short version - tl;dr" - which is probably a bit silly ... and which we may remove.
Let's see.


I'd like to hear your opinions, whether we should add more stuff, or not, ...
rgange, mdrapela, jlegendre, czimmermann.

Keep in mind that is has not yet been reviewed from a linguist or native speaker ... so please do not value the language for the time being.

Comment by Julie Legendre [ 03/Nov/17 ]

Reviewed.
Outstanding:

  • One small question about "UAdmin"
  • One comment from Christoph about a screenshot.
Comment by Christoph Meier [ 06/Nov/17 ]

Fixed the 2 issues.
And closed.

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