From 0e8c6586c552fc6689ceb29eedb82abf410bb1be Mon Sep 17 00:00:00 2001 From: Z Date: Thu, 2 Mar 2017 09:49:31 +0100 Subject: [PATCH] Delete siren.md Remove the remnants --- message/siren.md | 35 ----------------------------------- 1 file changed, 35 deletions(-) delete mode 100644 message/siren.md diff --git a/message/siren.md b/message/siren.md deleted file mode 100644 index b457e04..0000000 --- a/message/siren.md +++ /dev/null @@ -1,35 +0,0 @@ -# Siren -[Siren](https://github.com/kevinswiber/siren) is a simple, JSON-based format for representing entities and hypermedia controls. It is capable of transferring a JSON representation of a resource, related resources, link relations and actions ([HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) controls). - -Every Siren API response message SHOULD contain the `properties` field. If present, a representation of an entity MUST be under the `properties` field. - -A Siren message SHOULD contain the `class` field to denot - - -## Example -At minimum a response message might include some properties of resource it represents. In Siren, all the resource properties (data) are nested under the `properties` key. - -A minimal Siren document that transfer some data looks like: - -```json -{ - "properties": { - ... - } -} -``` - -Let's say the example response should represent an "Order" resource: - -```json -{ - "properties": { - "orderNumber": 42, - "itemCount": 3, - "status": "pending" - } -} -``` - - -