From 373696a81f2feb2818f5f839c29b2b329305efe4 Mon Sep 17 00:00:00 2001 From: Zero Date: Wed, 22 Jan 2020 19:26:21 -0500 Subject: [PATCH] Add route .../feed/community/ --- amino/no-auth.md | 194 ++++++++++++++++++++++++++++++++++++++++++++-- amino/no-auth.yml | 28 +++++-- 2 files changed, 206 insertions(+), 16 deletions(-) diff --git a/amino/no-auth.md b/amino/no-auth.md index 846935a..df526df 100644 --- a/amino/no-auth.md +++ b/amino/no-auth.md @@ -30,6 +30,20 @@ An auid was generated and returned by the server. It may now be used in request } ``` +- 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 @@ -76,6 +90,20 @@ Data with an unknown purpose is recieved } ``` +- 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 @@ -133,6 +161,20 @@ The client config was accepted } ``` +- 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 @@ -183,6 +225,20 @@ The appearance objects to use was retrieved } ``` +- 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 @@ -229,6 +285,20 @@ The language settings were retrieved } ``` +- 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 @@ -307,6 +377,20 @@ Community config was retrieved } ``` +- 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 @@ -365,6 +449,20 @@ The device config was accepted } ``` +- 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 @@ -430,6 +528,20 @@ The eventlog for this device profile. This data appears to be related to AB expe } ``` +- 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 @@ -529,6 +641,20 @@ discovery content modules were retrieved } ``` +- 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 @@ -584,7 +710,7 @@ The banner ads matching this id were retrieved ```JSON { - "allItemCount": "1 ", + "allItemCount": "1 ", "itemList": [ { "adCampaignId": "803326 ", @@ -605,9 +731,21 @@ The banner ads matching this id were retrieved } } ], - "paging": { - "nextPageToken": "... " - } + "paging": "{...} " +} +``` + +- 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 " } ``` @@ -660,6 +798,35 @@ __headers__ __responses__ +- 200 - Communities Retrieved +Communities Retrieved + +The communities for frontpage display were retrieved + +```JSON +{ + "allItemCount": "100 ", + "communityList": [ + "{...} " + ], + "paging": "{...} " +} +``` + +- 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 @@ -732,10 +899,21 @@ The blogs for frontpage display were retrieved "status": "0 " } }, - "paging": { - "nextPageToken": "... ", - "refreshPageToken": "... " - } + "paging": "{...} " +} +``` + +- 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 " } ``` diff --git a/amino/no-auth.yml b/amino/no-auth.yml index da1f2e6..fa75adc 100644 --- a/amino/no-auth.yml +++ b/amino/no-auth.yml @@ -277,7 +277,7 @@ vars: lang: JSON content: { - "allItemCount": "1 ", + "allItemCount": "1 ", "itemList": [ { "adCampaignId": "803326 ", @@ -298,9 +298,7 @@ vars: } } ], - "paging": { - "nextPageToken": "... " - } + "paging": "{...} " } topic-story: GET: @@ -323,10 +321,19 @@ vars: "status": "0 " } }, - "paging": { - "nextPageToken": "... ", - "refreshPageToken": "... " - } + "paging": "{...} " + } + topic-communities: + GET: + ok: + lang: JSON + content: + { + "allItemCount": "100 ", + "communityList": [ + "{...} " + ], + "paging": "{...} " } api_codes: api:104: @@ -478,3 +485,8 @@ routes: - $query-strings.all.size - $query-strings.all.pageToken - $query-strings.all.pagingType + responses: + "200": + title: Communities Retrieved + description: The communities for frontpage display were retrieved + body: $response.topic-communities.GET.ok