Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCU-1364

REST 2.1 updates

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Done
    • Icon: Major Major
    • None
    • None
    • None
    • None
    • Docu Sprint 45, Docu Sprint 46
    • 13

      Overview

      REST 2.1 is going to be released very soon.
      Note that it will be released independently from bundles or other modules.
      There are some rather "drastic" changes which must be reflected on the docs.

      Keep in mind that REST ist still a key feature which we hype e.g. with the hybrid headless jingle, we must make sure to do this updates quickly.

      Jira

      All 2.1 tickets

      Summary of the new features and changes

      Multiple configurations for the delivery endpoints are now possible.

      See MGNLREST-152.
      The structure of the (single) configuration has also changed.
      This must be reflected in:

      • API page
      • Getting started page
      • Erics's car example (Getting content on the client side)

       

      Localization of content

      See MGNLREST-153.
      Explain ho to use it.
      Explain the mechanisms how the "public locale" is determined (for public locale, see AdminCentral and public locales). 
      Explain the JSON structure - also how it is now different from what we got in response before (and on the nodes endpoint).
      Where?

      • Getting started page
      • API page (at least with a tiny note and link to somewhere else)
      • How to get content as JSON - an overview
      • others?

      Maybe also explain what is possible and what not.

      Asset renditions

      See MGNLREST-151

      Explain the usage on ..

      • Getting started page
      • API page (configuration?)

      Handling versions

      We have come up with the following decisions.

      • All pages besides the Delivery API reference page(s) refer to the latest version of REST and deal with the version 2 of the delivery endpoint definition
      • We keep the current Delivery endpoint API page as it is, renaming it to Delivery endpoint AP 2.0
      • We create a new version of the Delivery endpoint API dealing with the version 2 of the delivery endpoint definition, explaining the different ways to name the endpoint, localization, etc. ... will get subpages

      Further information

      The README file for the delivery endpoint has been updated.

      VN core team was implementing all these things. If you have questions, get in contact with sang.ngo or hieu.nguyen or mgeljic (try first with Sang and Hieu).

        Acceptance criteria

              Unassigned Unassigned
              cmeier Christoph Meier
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Created:
                Updated:
                Resolved: