[MGNLDEMO-309] Travel Demo includes example of Easy Outbound REST Created: 14/Feb/19  Updated: 13/May/20

Status: Accepted
Project: Magnolia Demo Projects
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Story Priority: Neutral
Reporter: Christopher Zimmermann Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoD:
[ ]* Doc/release notes changes? Comment present?
[ ]* Downstream builds green?
[ ]* Solution information and context easily available?
[ ]* Tests
[ ]* FixVersion filled and not yet released
[ ]  Architecture Decision Record (ADR)
Release notes required:
Yes
Documentation update required:
Yes
Date of First Response:
Epic Link: Easy Outbound REST

 Description   

As an evaluator, I want to see a concrete usecase of Easy Outbound REST in action, so I can understand and appreciate Magnoila.

As a developer, I want to see a concrete usecase so I can quickly understand the value of the feature.

Notes: 

Travel demo should connect to a REST service. Magnolia should provide the REST service, so that we dont need to configure secret Magnolia credentials, and so that customers and evaluators can use a downloaded demo bundle without needing special credentials (because it just links to our demo REST service).

Scenario:

Magnolia Travels has another department, the logistics department that determines the actual tour dates. The logistics department has its own in-house system, this tour-dates system stores all the dates for each of the tours. Each record contains:

  • ID
  • Name of Tour
  • Date Start 
  • Date End
  • Name of the Tour Guide

Acceptance Criteria:

  • A dummy "tour-dates" web service. It needs to provide consistant results, and always provide results for dates in the next year (so that we don't need to periodically change the service. Should be hosted on another subdomain. Ideally should not be served from a Magnolia instance.
  • A REST client is configured in a YAML file to connect to that service.
  • A new app "Tour Dates" shows all tours sorted chronologically, and supports paging.
  • Tour dates show up in the findbar search results.
  • Tours app has a new "tour dates" field. It is a multi field with link fields to the Tour dates service.
  • The Tour page FTL template has a section which lists the linked tour dates including the name of the guide.

Note:

This might be a good tool to provide the API with. At any rate it uses API conventions that are common and known in frontend dev world.

https://www.npmjs.com/package/json-server 

 

 

 



 Comments   
Comment by Christopher Zimmermann [ 24/Oct/19 ]

A scenario was suggested where content is retrieved from a weather service, I investigated this and decided against it because it would not provide a good use case for an app with external content - weather API's dont provide a list of weather stations, they just let you pass in a city name or lat-long and give the weather from that location.

We really want to demonstrate the app - and demonstrate fields which link from a JCR app to a REST backed app.

Generated at Mon Feb 12 05:18:24 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.