[MGNLREST-121] Provide REST documentation in a Markdown file for inclusion in docs Created: 05/Oct/17  Updated: 10/Oct/17  Resolved: 10/Oct/17

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

Type: Task Priority: Neutral
Reporter: Antti Hietala Assignee: Hieu Nguyen Duc
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: 0d
Time Spent: 7h
Original Estimate: 1d

Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Epic Link: REST Queries
Sprint: Saigon 117
Story Points: 3

 Description   

Update/rewrite Content Delivery Endpoint as README.md file

  • show the config samples as YAML (instead of JCR)
  • remove the security setup step, shouldn't be necessary anymore (use the new bypassWorkspaceAcls flag)
  • document usage & limitations of current queries
  • provide sample link (with placeholder host-name) to swagger live documentation (given sb installs swagger on his webapp)

Push into a doc subdir under magnolia-rest-content-delivery
or actually README.md on module level, and everything else in doc (resources, sub-snippets, images...)


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