Uploaded image for project: 'Magnolia REST Framework'
  1. Magnolia REST Framework
  2. MGNLREST-121

Provide REST documentation in a Markdown file for inclusion in docs

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • Neutral
    • 2.0
    • None
    • None
    • None
    • Saigon 117
    • 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...)

      Checklists

        Acceptance criteria

        Attachments

          Activity

            People

              hieu.nguyen Hieu Nguyen Duc
              ahietala Antti Hietala
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Checklists

                  Task DoR

                  Time Tracking

                    Estimated:
                    Original Estimate - 1d
                    1d
                    Remaining:
                    Remaining Estimate - 0d
                    0d
                    Logged:
                    Time Spent - 7h Time Not Required
                    7h