List Comments

List Comments is available as both a pgutil command and an HTTP Request, and will return an array of CommentInfo Object 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

A successful (200) response body will contain an array of BuildComment Object objects. For example, to listing all comments in release version 1.2.3 of a project myProject, the request would return this:

GET /api/sca/comments?project=myProject&version=1.2.3

[
  {
    "number":1,
    "by":"proget",
    "date":"2024-01-24T02:10:36.993Z",
    "comment":"I am a new comment."
  },
  {
    "number":2,
    "by":"proget",
    "date":"2024-01-24T03:56:51.55Z",
    "comment":"I am a newer comment."
  },
  {
    "number":3,
    "by":"proget",
    "date":"2024-01-24T04:03:38.51Z",
    "comment":"I am the newest comment."},
  {....}
]