List Comments

List Comments is available as both a pgutil command and an HTTP Request, and will return an array of BuildComment objects describing all comments in a project release.

Note, that if there are no comments in a release, an empty array is returned.

pgutil builds comments list --project=myProject --build=1.2.3

Command Specification (CLI)

The builds comments list command is used to list comments in a project's build.

The --project and --build options are always required.

Listing comments requires the project (e.g. myProject) and the build version number (e.g. 1.2.3):

pgutil builds comments list --project=myProject --build=1.2.3

Example output:

#1 - This is a comment
#3 - This is another comment

HTTP Request Specification

To list all comments of a release, simply GET to the URL with an appropriate API Key.

GET /api/sca/comments?project=«projectName»&version=«releaseVersion»

HTTP Response Specification

An array of BuildComment (see BuildComment.cs) objects will be returned on a successful 200 response. A 403 response indicates a missing, unknown, or unauthorized API Key.