zero
/
api-docs-mirror
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add route .../feed/community/

This commit is contained in:
Zero 2020-01-22 19:26:21 -05:00
parent dceb721e43
commit 373696a81f
2 changed files with 206 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

194
amino/no-auth.md
View File

@ -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 timestamp>",
"api:statuscode": "0 <Statuscode 0 is ok>",
"api:duration": "0.010s <Processing time>"
}
```
- 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 timestamp>",
"api:statuscode": "0 <Statuscode 0 is ok>",
"api:duration": "0.010s <Processing time>"
}
```
- 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 timestamp>",
"api:statuscode": "0 <Statuscode 0 is ok>",
"api:duration": "0.010s <Processing time>"
}
```
- 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 timestamp>",
"api:statuscode": "0 <Statuscode 0 is ok>",
"api:duration": "0.010s <Processing time>"
}
```
- 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 timestamp>",
"api:statuscode": "0 <Statuscode 0 is ok>",
"api:duration": "0.010s <Processing time>"
}
```
- 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 timestamp>",
"api:statuscode": "0 <Statuscode 0 is ok>",
"api:duration": "0.010s <Processing time>"
}
```
- 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 timestamp>",
"api:statuscode": "0 <Statuscode 0 is ok>",
"api:duration": "0.010s <Processing time>"
}
```
- 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 timestamp>",
"api:statuscode": "0 <Statuscode 0 is ok>",
"api:duration": "0.010s <Processing time>"
}
```
- 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 timestamp>",
"api:statuscode": "0 <Statuscode 0 is ok>",
"api:duration": "0.010s <Processing time>"
}
```
- 400:104 - Missing NDCDEVICEID
Missing NDCDEVICEID
@ -584,7 +710,7 @@ The banner ads matching this id were retrieved
```JSON
{
"allItemCount": "1 <Total returnable item count>",
"allItemCount": "1 <Total returnable item count>",
"itemList": [
{
"adCampaignId": "803326 <Likely related to ad grouping by campaign, use unknown>",
@ -605,9 +731,21 @@ The banner ads matching this id were retrieved
}
}
],
"paging": {
"nextPageToken": "... <Page token>"
}
"paging": "{...} <Paging info>"
}
```
- 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>"
}
```
@ -660,6 +798,35 @@ __headers__
__responses__
- 200 - Communities Retrieved
Communities Retrieved
The communities for frontpage display were retrieved
```JSON
{
"allItemCount": "100 <Total returnable item count>",
"communityList": [
"{...} <Community object>"
],
"paging": "{...} <Paging info>"
}
```
- 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
@ -732,10 +899,21 @@ The blogs for frontpage display were retrieved
"status": "0 <Unknown>"
}
},
"paging": {
"nextPageToken": "... <Page token>",
"refreshPageToken": "... <Unknown use>"
}
"paging": "{...} <Paging info>"
}
```
- 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>"
}
```

28
amino/no-auth.yml
View File

@ -277,7 +277,7 @@ vars:
lang: JSON
content:
{
"allItemCount": "1 <Total returnable item count>",
"allItemCount": "1 <Total returnable item count>",
"itemList": [
{
"adCampaignId": "803326 <Likely related to ad grouping by campaign, use unknown>",
@ -298,9 +298,7 @@ vars:
}
}
],
"paging": {
"nextPageToken": "... <Page token>"
}
"paging": "{...} <Paging info>"
}
topic-story:
GET:
@ -323,10 +321,19 @@ vars:
"status": "0 <Unknown>"
}
},
"paging": {
"nextPageToken": "... <Page token>",
"refreshPageToken": "... <Unknown use>"
}
"paging": "{...} <Paging info>"
}
topic-communities:
GET:
ok:
lang: JSON
content:
{
"allItemCount": "100 <Total returnable item count>",
"communityList": [
"{...} <Community object>"
],
"paging": "{...} <Paging info>"
}
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