From 099501966daf774f2afe0939640c1d672308ed70 Mon Sep 17 00:00:00 2001 From: Zero Date: Wed, 22 Jan 2020 20:26:15 -0500 Subject: [PATCH] add route .../announcement --- amino/no-auth.md | 91 +++++++++++++++++++++++++++++++++++++++++++++++ amino/no-auth.yml | 53 +++++++++++++++++++++++++++ 2 files changed, 144 insertions(+) diff --git a/amino/no-auth.md b/amino/no-auth.md index df526df..3673849 100644 --- a/amino/no-auth.md +++ b/amino/no-auth.md @@ -1,3 +1,94 @@ +
+GET /g/s/announcement/ +GET the current announcement. This is actually just info about a bunch of communities and public chats + +__query strings__ + +|name|description|required| +| - | - | - | +|start|paginated data index offset. Difference to|False| +|size|max number of items to get for paginated requests|False| +|language|Content language to be returned|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 - Info Retrieved +Info Retrieved + +Announcement blogs and threads were retrieved + +```JSON +{ + "communityInfoMapping": { + "": "{...} " + }, + "paging": "{...} ", + "playlistInThreadList": { + "<->": " ", + "": { + "currentItemIndex": "14 ", + "currentItemStatus": "2 ", + "items": [ + "{...} " + ] + } + }, + "threadList": [ + "{...} " + ], + "userInfoInThread": { + "<->": " ", + "": { + "userProfileCount": 2, + "userProfileList": [ + "{...} " + ] + } + } +} +``` + +- 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:statuscode": "0 ", + "api:duration": "0.010s " +} +``` + +- 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:statuscode": "104 ", + "api:duration": "0.000s " +} +``` + + +
+ +
GET /g/s/auid/ GET an auid for this device diff --git a/amino/no-auth.yml b/amino/no-auth.yml index fa75adc..9761363 100644 --- a/amino/no-auth.yml +++ b/amino/no-auth.yml @@ -31,10 +31,18 @@ vars: name: pageToken description: page token for paginated requests required: false + start: + name: start + description: paginated data index offset. Difference to + required: false size: name: size description: max number of items to get for paginated requests required: false + language: + name: language + description: Content language to be returned + required: false pagingType: name: pagingType description: Seems to have no effect, default value is `t` @@ -335,6 +343,39 @@ vars: ], "paging": "{...} " } + announcement: + GET: + ok: + lang: JSON + content: + { + "communityInfoMapping": { + "": "{...} " + }, + "paging": "{...} ", + "playlistInThreadList": { + "<->": " ", + "": { + "currentItemIndex": "14 ", + "currentItemStatus": "2 ", + "items": [ + "{...} " + ] + } + }, + "threadList": [ + "{...} " + ], + "userInfoInThread": { + "<->": " ", + "": { + "userProfileCount": 2, + "userProfileList": [ + "{...} " + ] + } + } + } api_codes: api:104: lang: JSON @@ -490,3 +531,15 @@ routes: title: Communities Retrieved description: The communities for frontpage display were retrieved body: $response.topic-communities.GET.ok + /g/s/announcement/: + GET: + description: GET the current announcement. This is actually just info about a bunch of communities and public chats + query strings: + - $query-strings.all.start + - $query-strings.all.size + - $query-strings.all.language + responses: + "200": + title: Info Retrieved + description: Announcement blogs and threads were retrieved + body: $response.announcement.GET.ok