Add route .../announcement/

Add it correctly this time, no mix ups!
This commit is contained in:
Zero 2020-01-22 20:34:42 -05:00
parent e005acf693
commit 60c87f0b46
2 changed files with 91 additions and 0 deletions

View File

@ -1,3 +1,71 @@
<details>
<summary>GET /g/s/announcement/</summary>
GET the announcement blog list
__query string__
|name|description|required|
| - | - | - |
|language|Content language to be returned|False|
|start|paginated data index offset. Difference to|False|
|size|max number of items to get for paginated requests|False|
__headers__
|name|description|required|
| - | - | - |
|NDCDEVICEID|The device id generated by the app. See|True|
|NDC-MSG-SIG|Message signature (?) generated by the app|False|
|SMDEVICEID|I don't know, seems to be a non-string hex number|False|
|AUID|The auid (UUIDv4) generated on amino servers for this client, retrieved with GET /g/s/auid|False|
__responses__
- 200 - Announcements Retrieved
Announcements Retrieved
Current announcement blogs were retrieved
```JSON
{
"blogList": [
"{...} <Blog object. Always by System (UUIDv4 all 0's)>"
]
}
```
- 200:0 - api:ok
api:ok
The request was successful. This is not a separate response, but included in every 200 response's json
```JSON
{
"api:message": "OK",
"api:timestamp": "2020-01-22T23:49:13Z <API timestamp>",
"api:statuscode": "0 <Statuscode 0 is ok>",
"api:duration": "0.010s <Processing time>"
}
```
- 400:104 - Missing NDCDEVICEID
Missing NDCDEVICEID
The NDCDEVICEID header was not included, or did not compute on amino servers
```JSON
{
"api:message": "Invalid Request. Please update to the latest version. If the problem continues, please contact us.",
"api:timestamp": "2020-01-22T22:11:28Z <API timestamp>",
"api:statuscode": "104 <Statuscode 104 represents a bad NDCDEVICEID header>",
"api:duration": "0.000s <Processing time>"
}
```
</details>
<details>
<summary>GET /g/s/auid/</summary>
GET an auid for this device

View File

@ -376,6 +376,17 @@ vars:
}
}
}
announcement:
GET:
ok:
lang: JSON
content:
{
"blogList": [
"{...} <Blog object. Always by System (UUIDv4 all 0's)>"
]
}
api_codes:
api:104:
lang: JSON
@ -542,3 +553,15 @@ routes:
title: Chats Retrieved
description: Chat info and users were retrieved
body: $response.live-layer.GET.ok
/g/s/announcement/:
GET:
description: GET the announcement blog list
query string:
- $query-strings.all.language
- $query-strings.all.start
- $query-strings.all.size
responses:
"200":
title: Announcements Retrieved
description: Current announcement blogs were retrieved
body: $response.announcement.GET.ok