Internet Explorer is no longer supported. Many things will still work, but your experience will be degraded and some things won't function. Please use a modern browser such as Edge, Chrome, or Firefox.
 
No matching results found

Create/Update Comment

view on GitHub

Create/Update Comment is available as both a pgutil command and an HTTP Request, and will create a new comment or update properties on an existing comment, and return a BuildComment Object object describing the new or updated comment.

🚀 Quick Example: Creating a New Comment with pgutil

This example creates a comment (Checked for errors on 01/01) in version 1.2.3 of a project named myProject:

pgutil builds comments create --project=myProject --build=1.2.3 --comment="Checked for errors on 01/01"

Command Specification (CLI)

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

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

Creating a comment requires the project (e.g. myProject), the build version number (e.g. 1.2.3), and the comment (e.g. This is a comment)

pgutil builds comments create --project=myProject --build=1.2.3 --comment="This is a comment"

HTTP Request Specification

To create or update a comment, simply POST to the URL with an appropriate API Key and a BuildComment Object object as the request body.

POST /api/sca/comments

HTTP Response Specification

Response Details
200 (Success) indicates the comment was successfully entered
400 (Invalid Input) indicates invalid or missing properties on the BuildComment object; the body will provide some details as text
403 (Unauthorized API Key) indicates a missing, unknown, or unauthorized API Key; the body will be empty
500 (Server Error) indicates an unexpected error; the body will contain the message and stack trace, and this will also be logged
In this article

inedo.com | Support | MyInedo

docs © 2024 Inedo, LLC