Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Delete siren.md

Browse Source 
Remove the remnants
This commit is contained in:
Z
2017-03-02 09:49:31 +01:00
committed by GitHub
parent da89020d9d
commit 0e8c6586c5
1 changed files with 0 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
message/siren.md
View File

@@ -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"
}
}
```