Requirements

Introduction

This document defines the desired scope of this project

Apps/Libs to showcase

• sumo_rest
  • swagger
  • trails
  • mixer
  • cowboy
  • sumo_db
• lasse
• shotgun (for tests)
• ktn_meta_SUITE (for tests)

REST API

• POST|GET /newspapers - part of the CRUD for newspapers

• GET|PUT|DELETE /newspapers/:id - part of the CRUD for newspapers

• POST /newspapers/:name/news - publish a new news flash for newspaper :name

• GET /newspapers/:name/news/:id - retrieves data for a particular news flash

• GET /news - implemented with SSE

  • field id will be a unique id
  • field event will be the newspaper
  • field data will be the news flash in json format

Entities

Newspapers

• name (binary): unique identifier (doesn't allow duplicates)
• description (binary): field that can be modified

News Flashes

• id (binary): autogenerated unique identifier
• newspaper_name (binary): name of the newspaper where this news flash is published
• title (binary)
• body (binary)