Skip to content
This repository has been archived by the owner on Feb 4, 2020. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
Constantine Colotiline committed Nov 4, 2014
2 parents 0e6bfc3 + 94c349b commit 09ed59a
Showing 1 changed file with 35 additions and 27 deletions.
62 changes: 35 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,37 +9,37 @@ Reversed API documentation
```json
{
root: [{
"title" : "[Title]",
"screen_type" : "[screenType]",
"title": "[Title]",
"screen_type": "[screenType]",
collection: [{
"[uri]"
}],
"updated_at":1413818419,
"main": "[uri]"
"updated_at": 1413818419
}],
documents: {
"[uri]": {
"url": "[uri]",
"title" : "[title]",
"second_title" : "[secondTitle]",
"title": "[title]",
"second_title": "[secondTitle]",
"authors": [
["Author"]
],
"document_type" : "[documentType]",
"document_type": "[documentType]",
"version":[versionInt],
"published_at":1413814542,
"updated_at":1413814542,
"full":[isFullBoolean],
"source": {
"url" : "[sourceUrl]",
"name" : "[sourceName]",
"quote" : "[sourceQuote]"
"url": "[sourceUrl]",
"name": "[sourceName]",
"quote": "[sourceQuote]"
},
"image": {
"original_url" : "[originalImageUri]",
"large_url" : "[largeImageUri]",
"small_url" : "[smallImageUri]",
"caption" : "[caption]",
"credit" : "[credit]"
"original_url": "[originalImageUri]",
"large_url": "[largeImageUri]",
"small_url": "[smallImageUri]",
"caption": "[caption]",
"credit": "[credit]"
}
}
}
Expand All @@ -51,6 +51,14 @@ Reversed API documentation

`[funType]` can be `video`, `coub`, `picture`, `infographics`.

### Additional JSON base on `[screenType]
#### Is contained in `root` property

`news`
```json
"main": "[uri]"
```

### Additional JSON based on `[documentType]`
#### Is contained in `documents` property

Expand All @@ -60,28 +68,28 @@ Reversed API documentation
"table_of_contents":[
"[chapterName]"
],
"thesis" : "[thesis]",
"chapters" : [{
"title" : "[title]",
"content" : "[content]"
"thesis": "[thesis]",
"chapters": [{
"title": "[title]",
"content": "[content]"
}],
"layout_url" : "[layoutUrl]",
"bg_image" : {
"large_url" : "[largeBgUri]",
"small_url" : "[smallBgUri]",
"caption" : "[caption]",
"credit" : "[credit]"
"layout_url": "[layoutUrl]",
"bg_image": {
"large_url": "[largeBgUri]",
"small_url": "[smallBgUri]",
"caption": "[caption]",
"credit": "[credit]"
}
```

`fun`
```json
"fun_type" : "[funType]"
"fun_type": "[funType]"
```

`topic`
```json
"content" : [
"content": [
"[uri]"
]
```

0 comments on commit 09ed59a

Please sign in to comment.