Comment on a file.
curl --request POST \
--url https://api.example.com/api/v0/repositories/{repo_id}/comments/files/{path} \
--header 'Content-Type: application/json' \
--data '
{
"content": "<string>",
"lines": {
"start": 123,
"end": 123
},
"parent": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.example.com/api/v0/repositories/{repo_id}/comments/files/{path}"
payload = {
"content": "<string>",
"lines": {
"start": 123,
"end": 123
},
"parent": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
content: '<string>',
lines: {start: 123, end: 123},
parent: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.example.com/api/v0/repositories/{repo_id}/comments/files/{path}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v0/repositories/{repo_id}/comments/files/{path}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'content' => '<string>',
'lines' => [
'start' => 123,
'end' => 123
],
'parent' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v0/repositories/{repo_id}/comments/files/{path}"
payload := strings.NewReader("{\n \"content\": \"<string>\",\n \"lines\": {\n \"start\": 123,\n \"end\": 123\n },\n \"parent\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v0/repositories/{repo_id}/comments/files/{path}")
.header("Content-Type", "application/json")
.body("{\n \"content\": \"<string>\",\n \"lines\": {\n \"start\": 123,\n \"end\": 123\n },\n \"parent\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v0/repositories/{repo_id}/comments/files/{path}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"content\": \"<string>\",\n \"lines\": {\n \"start\": 123,\n \"end\": 123\n },\n \"parent\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}Repositories
Comment on a file.
Access control rules
- The requester must have access to the repository.
POST
/
api
/
v0
/
repositories
/
{repo_id}
/
comments
/
files
/
{path}
Comment on a file.
curl --request POST \
--url https://api.example.com/api/v0/repositories/{repo_id}/comments/files/{path} \
--header 'Content-Type: application/json' \
--data '
{
"content": "<string>",
"lines": {
"start": 123,
"end": 123
},
"parent": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://api.example.com/api/v0/repositories/{repo_id}/comments/files/{path}"
payload = {
"content": "<string>",
"lines": {
"start": 123,
"end": 123
},
"parent": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
content: '<string>',
lines: {start: 123, end: 123},
parent: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://api.example.com/api/v0/repositories/{repo_id}/comments/files/{path}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v0/repositories/{repo_id}/comments/files/{path}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'content' => '<string>',
'lines' => [
'start' => 123,
'end' => 123
],
'parent' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/api/v0/repositories/{repo_id}/comments/files/{path}"
payload := strings.NewReader("{\n \"content\": \"<string>\",\n \"lines\": {\n \"start\": 123,\n \"end\": 123\n },\n \"parent\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/api/v0/repositories/{repo_id}/comments/files/{path}")
.header("Content-Type", "application/json")
.body("{\n \"content\": \"<string>\",\n \"lines\": {\n \"start\": 123,\n \"end\": 123\n },\n \"parent\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v0/repositories/{repo_id}/comments/files/{path}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"content\": \"<string>\",\n \"lines\": {\n \"start\": 123,\n \"end\": 123\n },\n \"parent\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}{
"msg": "<string>"
}Body
application/json
Create a new comment on a file.
The content is expected to be valid markdown, but this is not validated at this time.
Users can "ping" other users by using:
@projectto ping all company users associated with the company, or@usernameto ping auditors (reviewers, judges and triagers) that are part of the repository.
A ping will cause the pinged user(s) to receive a notification.
The line(s) refered to in the comment.
Notes
This must be not be used if parent is set.
Show child attributes
Show child attributes
Comment is in a reply to a thread.
Response
Comment made
⌘I