Get post's comments

Get all comments of a specific post.

Path Parameters

postId string required

The id of the post.

Responses

• 200
• 400
• 401
• 403
• 404
• 422
• 429
• 500
• 502
• 503
• 504

---

Request has been handled successfully.

application/json

Schema

Example (from schema)

---

Schema

success boolean
data object
comments object[]
List of comments that belong to the post.
Array [
id integer required
The id of the comment.
createdAt string required
The creation date of the comment.
hidden boolean required
Whether the comment is hidden.
body string required
The body of the comment.
parentId integer nullable required
The parent comment's id. Will be null if this comment does not have a parent.
author object
Details about the author.
id integer required
The id of the author of the comment.
username string required
The username of the author of the comment.
firstName string required
The first name of the author of the comment.
lastName string required
The first name of the author of the comment.
displayName string required
The display name of the author of the comment.
verified boolean required
Whether the comment's author has been verified.
profileImage string nullable required
The profile image of the author of the comment. Will be null if it's empty
followed boolean required
Whether the current user is following the author of the comment or not.
]

{
  "success": true,
  "data": {
    "comments": [
      {
        "id": 135,
        "createdAt": "2018-06-27T14:49:10.000Z",
        "hidden": false,
        "body": "Ma shaa Allah Lahawla walaquwata illa billah",
        "parentId": 135,
        "author": {
          "id": 135,
          "username": "amer",
          "firstName": "Amer",
          "lastName": "Abbas",
          "displayName": "A Abbas",
          "verified": true,
          "profileImage": "//s3.amazonaws.com/qreflect-bucket/events/banner/en/avatars/15514/medium.png?1655384045",
          "followed": true
        }
      }
    ]
  }
}

The request is missing required parameters or is invalid.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The request is missing required headers or is invalid",
  "type": "invalid_request",
  "success": false
}

The request is unauthorized.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The request requires user authentication",
  "type": "unauthorized",
  "success": false
}

Forbidden error. Can either be due to access token not being passed, having been expired or the caller trying to access a resource without enough permissions.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The server understood the request, but refuses to authorize it",
  "type": "forbidden",
  "success": false
}

Not Found. The resource being accessed does not exist.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The requested resource could not be found",
  "type": "not_found",
  "success": false
}

Validation Error. The request includes one or more invalid params. Please check the request params and try again.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The request was well-formed but was unable to be followed due to semantic errors",
  "type": "unprocessable_entity",
  "success": false
}

Too many requests, please try again later.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "Too many requests, please try again later",
  "type": "rate_limit_exceeded",
  "success": false
}

Server Error. Something went wrong, try again later.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The server encountered an internal error and was unable to complete your request",
  "type": "internal_server_error",
  "success": false
}

Invalid response from the upstream server

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The server was acting as a gateway or proxy and received an invalid response from the upstream server",
  "type": "bad_gateway",
  "success": false
}

The server is currently unable to handle the request due to a temporary overload or scheduled maintenance

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance",
  "type": "service_unavailable",
  "success": false
}

The server did not receive a timely response from the upstream server.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string
success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": false
}

{
  "message": "The server was acting as a gateway or proxy and did not receive a timely response from the upstream server",
  "type": "gateway_timeout",
  "success": false
}

Loading...