[DOCU-1364] REST 2.1 updates Created: 07/Mar/18  Updated: 22/Mar/18  Resolved: 22/Mar/18

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

Type: Story Priority: Major
Reporter: Christoph Meier Assignee: Unassigned
Resolution: Done Votes: 0
Labels: None
Σ Remaining Estimate: Not Specified Remaining Estimate: Not Specified
Σ Time Spent: Not Specified Time Spent: Not Specified
Σ Original Estimate: Not Specified Original Estimate: Not Specified

Issue Links:
relation
is related to DOCU-1189 Update "Accessing content on the clie... Closed
Sub-Tasks:
Key
Summary
Type
Status
Assignee
DOCU-1367 Update "How to get content as JSON - ... Sub-task Closed Christoph Meier  
DOCU-1368 Explain the "localized content" story Sub-task Closed Martin Drápela  
DOCU-1370 Create new version of the "Delivery e... Sub-task Closed Christoph Meier  
DOCU-1371 Move delivery e.p. configuration to s... Sub-task Closed Christoph Meier  
DOCU-1374 Delivery endpoint API v2 Sub-task Closed Christoph Meier  
DOCU-1375 Delivery endpoint API v1 Sub-task Closed Christoph Meier  
DOCU-1376 Reference resolving Sub-task Closed Christoph Meier  
DOCU-1378 Update the examples in the Filters se... Sub-task Closed Martin Drápela  
Template:
Acceptance criteria:
Empty
Date of First Response:
Sprint: Docu Sprint 45, Docu Sprint 46
Story Points: 13

 Description   

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).



 Comments   
Comment by Mikaël Geljić [ 07/Mar/18 ]

Nice summary!

FYI the README file is being updated. This is not merged yet (MGNLREST-171).
Additionally, we will also have "regular" reference links (e.g. to pages, tours), not only expansion of assets & rendition links (MGNLREST-107).

Comment by Christoph Meier [ 07/Mar/18 ]

Yep. Currently I am reading the updated README from the pull request

Comment by Christoph Meier [ 22/Mar/18 ]

All published besides the "Getting started with REST" - which becomes an own distinct task.

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