RESTful API Help

Create

Create new code comment

Http Method

POST

End Point

/~api/code-comments

Request Body

Content Type: application/json
Example: {

"projectId" : 1 ,
"userId" : 1 ,
"content" : "string" ,
"createDate" : "2024-04-19T18:56:47.027+00:00" ,
"lastActivity" : {

"userId" : 1 ,
"date" : "2024-04-19T18:56:47.028+00:00" ,
"description" : "string"

} ,
"replyCount" : 1 ,
"mark" : {

"commitHash" : "string" ,
"path" : "string" ,
"range" : {

"fromRow" : 1 ,
"fromColumn" : 1 ,
"toRow" : 1 ,
"toColumn" : 1 ,
"tabWidth" : 1

}

} ,
"compareContext" : {

"pullRequestId" : 1 ,
"oldCommitHash" : "string" ,
"newCommitHash" : "string" ,
"pathFilter" : "string" ,
"currentFile" : "string" ,
"whitespaceOption" : "DEFAULT"

} ,
"resolved" : true ,
"uuid" : "string"

}

Response

Operation Successful

Status Code

200

Response Body

Content Type: application/json
Example: 1

Operation Failed

Status code: Status code other than 200 indicating the error type
Response Body: Error detail of content type "text/plain"

cURL Example

$ curl -u <login name>:<password or access token> -X POST [email protected] -H "Content-Type: application/json" https://crash.software/~api/code-comments