The consumer of this API will be able to:
- Retrieve a list of all the comments in a blog posting
- Retrieve all the information of a given comment: the final goal is to be able to render a comment with the result of the API call
- The following information will be provided as a link or as an embedded resource: author (Person), replies (comment).
The list of comments should only include comments if the current user has permissions to view the whole list, otherwise the list returned will be empty. If a comment is requested and the current user doesn't have permission to view it, a 404 error should be returned.
The API should support at least Plain JSON, JSON-LD and HAL as output formats.
The consumer developer should be able to control which linked resources are embedded so that they can be retrieved along with a comment in a single request.
The consumer developer can specify which fields are desired, to reduce the data transfer when the API is used from a consumer sensitive to it.