iv-org/documentation
1
0
Fork 0
mirror of https://github.com/iv-org/documentation.git synced 2024-10-01 01:35:51 -04:00
Code Issues Packages Projects Releases Wiki Activity

add documentation for channel community endpoint (#333)

Browse Source 
Co-authored-by: Samantaz Fox <coding@samantaz.fr>
This commit is contained in:
ChunkyProgrammer 2023-03-19 09:33:34 -04:00 committed by GitHub
parent 410f7d1603
commit fc62ef9763
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 78 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
docs/api/channels_endpoint.md
View File

@ -125,3 +125,81 @@ See: GET `/api/v1/channels/:id/videos`
"continuation": String
}
```
##### GET `/api/v1/channels/:id/community`
Please refer to the [Community Post Attachment types](#community-post-attachment-types) below for more details on the attachment JSON objects used below.
> Url parameters
* `continuation`: A continuation token to get the next chunk of items.
> Response:
```javascript
{
"authorId": String,
"comments": {
"attachment": ImageAttachment | MultiImageAttachment | VideoAttachment | PollAttachment
"author": String,
"authorIsChannelOwner": Boolean
"authorId": String,
"authorThumbnails": ImageObject[],
"authorUrl": String,
"commentId": String,
"content": String,
"contentHtml": String,
"isEdited": Boolean,
"likeCount": Number,
"published": Number,
"publishedText": String,
"replyCount": Number
}[]
}
```
###### Community Post Attachment Types
__VideoAttachment__
See [VideoObject](./common_types.md#videoobject) common type
__ImageAttachment__
```javascript
{
"type": "image",
"imageThumbnails": ImageObject[]
}
```
__MultiImageAttachment__
```javascript
{
"type": "multiImage",
"images": ImageObject[][]
}
```
__PollAttachment__
```javascript
{
"type": "poll",
"totalVotes": Number,
"choices": {
"text": String,
"image?": ImageObject[]
}[]
}
```
__Unknown__
This usually means that parsing support for the attachment type has not yet been implemented.
```javascript
{
"type": "unknown",
"error": String
}
```