Skip to content

API Doc: Comments Access

Ryan Satyabrata edited this page Nov 4, 2016 · 8 revisions

GET /posts/{POST_ID}/comments

(not yet implemented)
Used to get all the comments of the post. Used with HTTP GET, {POST_ID} is the UUID of the post, which is required.
One can add pagination query strings.

It returns a JSON object which contains an author field

Here is an example:
GET /posts/92c4cbd3-2e36-4b53-a66b-01bff793e62d/comments HTTP/1.1
Header: Value

200 Ok ...
{
	"query": "comments",
        # comments about the post
        # returnss a maximum number of comments
        # A list of posts
    	"count": 1023,
    	"size": 50,
    	# Does not return next if last page
        "next": "http://service/posts/{post_id}/comments?page=5",
    	# Does not return previous if page is 0.
    	"previous": "http://service/posts/{post_id}/comments?page=3",
        "comments":[ {
		"author":{
		    # ID of the Author (UUID)
			"id":"de305d54-75b4-431b-adb2-eb6b9e546013",
			"host":"http://127.0.0.1:5454/",
			"displayName":"Greg Johnson",
			# url to the authors information
			"url":"http://127.0.0.1:5454/author
				/9de17f29c12e8f97bcbbd34cc908f1baba40658e",
			# HATEOS url for Github API
			"github": "http://github.com/gjohnson"
		},
		"comment":"Sick Olde English",
		"contentType":"text/x-markdown",
		# ISO 8601 TIMESTAMP
		"pubDate":"2015-03-09T13:07:04+00:00",
		# ID of the Comment (UUID)
		"guid":"de305d54-75b4-431b-adb2-eb6b9e546013"
	}, {
		"author":{
		    # ID of the Author (UUID)
			"id":"ab405d54-56d7-431b-adb2-eb6b8e165314",
			"host":"http://127.0.0.1:5454/",
			"displayName":"Leeroy Jenkins",
			# url to the authors information
			"url":"http://127.0.0.1:5454/author
				/9ab17f29c12e8f97bcbbd34cc908f1baba40658e",
			# HATEOS url for Github API
			"github": "http://github.com/leeeroy"
		},
		"comment":"Leeeeeeeeeeeeeroy!",
		"contentType":"text/x-markdown",
		# ISO 8601 TIMESTAMP
		"pubDate":"2015-03-09T14:15:04+00:00",
		# ID of the Comment (UUID)
		"guid":"ab405d54-56d7-431b-adb2-eb6b8e165314"
	}]
}

Clone this wiki locally