Change: Update a review comment (repo_id addressing)

curl --request PATCH \
  --url https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/reviews/{review_id}/comments/{comment_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "body": "<string>",
  "confidence": 0.5,
  "status_reason": "<string>"
}
'

import requests

url = "https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/reviews/{review_id}/comments/{comment_id}"

payload = {
    "body": "<string>",
    "confidence": 0.5,
    "status_reason": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({body: JSON.stringify('<string>'), confidence: 0.5, status_reason: '<string>'})
};

fetch('https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/reviews/{review_id}/comments/{comment_id}', 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://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/reviews/{review_id}/comments/{comment_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'body' => '<string>',
    'confidence' => 0.5,
    'status_reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/reviews/{review_id}/comments/{comment_id}"

	payload := strings.NewReader("{\n  \"body\": \"<string>\",\n  \"confidence\": 0.5,\n  \"status_reason\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.patch("https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/reviews/{review_id}/comments/{comment_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"body\": \"<string>\",\n  \"confidence\": 0.5,\n  \"status_reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/reviews/{review_id}/comments/{comment_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"body\": \"<string>\",\n  \"confidence\": 0.5,\n  \"status_reason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "actor_display_name": "<string>",
  "actor_id": "<string>",
  "actor_identity": {
    "account_id": "<string>",
    "avatar_url": "<string>",
    "display_name": "<string>",
    "handles": [
      {
        "handle": "<string>",
        "provider": "<string>",
        "is_primary": true
      }
    ],
    "kind": "<string>",
    "agent": {
      "id": "<string>",
      "name": "<string>"
    },
    "automation": {
      "automation_id": "<string>",
      "installation_id": "<string>",
      "plugin": "<string>"
    },
    "run_id": "<string>",
    "username": "<string>"
  },
  "body": "<string>",
  "client_id": "<string>",
  "client_id_hash": "<string>",
  "code_version_id": "<string>",
  "confidence": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "discussion_id": "<string>",
  "discussion_message_count": 123,
  "id": "<string>",
  "location": {
    "code_version_id": "<string>",
    "end_column": 123,
    "end_line": 123,
    "file_path": "<string>",
    "granularity": "<string>",
    "id": "<string>",
    "language": "<string>",
    "nearby_text": "<string>",
    "review_comment_id": "<string>",
    "selected_text": "<string>",
    "start_column": 123,
    "start_line": 123
  },
  "repo_id": "<string>",
  "review_id": "<string>",
  "severity": "<string>",
  "stale_checked_at": "2023-11-07T05:31:56Z",
  "stale_checked_code_version_id": "<string>",
  "stale_outcome": "<string>",
  "status": "<string>",
  "status_actor_display_name": "<string>",
  "status_actor_id": "<string>",
  "status_actor_identity": {
    "account_id": "<string>",
    "avatar_url": "<string>",
    "display_name": "<string>",
    "handles": [
      {
        "handle": "<string>",
        "provider": "<string>",
        "is_primary": true
      }
    ],
    "kind": "<string>",
    "agent": {
      "id": "<string>",
      "name": "<string>"
    },
    "automation": {
      "automation_id": "<string>",
      "installation_id": "<string>",
      "plugin": "<string>"
    },
    "run_id": "<string>",
    "username": "<string>"
  },
  "status_actor_kind": "<string>",
  "status_changed_at": "2023-11-07T05:31:56Z",
  "status_reason": "<string>",
  "status_source": "<string>",
  "trail_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "$schema": "/api/v1/schemas/ReviewCommentJSON.json",
  "agent_verdict": {
    "created_at": "2023-11-07T05:31:56Z",
    "evidence": "<string>",
    "outcome": "resolved",
    "run_id": "<string>",
    "verdict": "fixed"
  },
  "source": {
    "agent": {
      "id": "<string>",
      "name": "<string>"
    },
    "run_id": "<string>"
  }
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

Reviews

Change: Update a review comment (repo_id addressing)

Users Plugins

Accepted credentials: User token, Plugin installation token.

Use an own-account bearer token (including supported service accounts) or a Core-issued plugin installation bearer token, subject to the permissions and restrictions below. Plugin assertion JWTs and plugin OAuth user-delegation tokens are not accepted here.

Requires live repository push or write_findings permission (contents:write or findings:write for plugin installations); platform publish_review alone does not authorize PATCH. A caller without push may update only comments on reviews it authored. Comment-field and status-transition rules still apply. Trails must be enabled. Send requests to the repository’s primary API region.

PATCH

repos

{repo_id}

changes

{number}

reviews

{review_id}

comments

{comment_id}

Change: Update a review comment (repo_id addressing)

curl --request PATCH \
  --url https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/reviews/{review_id}/comments/{comment_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "body": "<string>",
  "confidence": 0.5,
  "status_reason": "<string>"
}
'

import requests

url = "https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/reviews/{review_id}/comments/{comment_id}"

payload = {
    "body": "<string>",
    "confidence": 0.5,
    "status_reason": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({body: JSON.stringify('<string>'), confidence: 0.5, status_reason: '<string>'})
};

fetch('https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/reviews/{review_id}/comments/{comment_id}', 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://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/reviews/{review_id}/comments/{comment_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'body' => '<string>',
    'confidence' => 0.5,
    'status_reason' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "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://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/reviews/{review_id}/comments/{comment_id}"

	payload := strings.NewReader("{\n  \"body\": \"<string>\",\n  \"confidence\": 0.5,\n  \"status_reason\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.patch("https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/reviews/{review_id}/comments/{comment_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"body\": \"<string>\",\n  \"confidence\": 0.5,\n  \"status_reason\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://aws-us-east-2.api.entire.io/api/v1/repos/{repo_id}/changes/{number}/reviews/{review_id}/comments/{comment_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"body\": \"<string>\",\n  \"confidence\": 0.5,\n  \"status_reason\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "actor_display_name": "<string>",
  "actor_id": "<string>",
  "actor_identity": {
    "account_id": "<string>",
    "avatar_url": "<string>",
    "display_name": "<string>",
    "handles": [
      {
        "handle": "<string>",
        "provider": "<string>",
        "is_primary": true
      }
    ],
    "kind": "<string>",
    "agent": {
      "id": "<string>",
      "name": "<string>"
    },
    "automation": {
      "automation_id": "<string>",
      "installation_id": "<string>",
      "plugin": "<string>"
    },
    "run_id": "<string>",
    "username": "<string>"
  },
  "body": "<string>",
  "client_id": "<string>",
  "client_id_hash": "<string>",
  "code_version_id": "<string>",
  "confidence": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "discussion_id": "<string>",
  "discussion_message_count": 123,
  "id": "<string>",
  "location": {
    "code_version_id": "<string>",
    "end_column": 123,
    "end_line": 123,
    "file_path": "<string>",
    "granularity": "<string>",
    "id": "<string>",
    "language": "<string>",
    "nearby_text": "<string>",
    "review_comment_id": "<string>",
    "selected_text": "<string>",
    "start_column": 123,
    "start_line": 123
  },
  "repo_id": "<string>",
  "review_id": "<string>",
  "severity": "<string>",
  "stale_checked_at": "2023-11-07T05:31:56Z",
  "stale_checked_code_version_id": "<string>",
  "stale_outcome": "<string>",
  "status": "<string>",
  "status_actor_display_name": "<string>",
  "status_actor_id": "<string>",
  "status_actor_identity": {
    "account_id": "<string>",
    "avatar_url": "<string>",
    "display_name": "<string>",
    "handles": [
      {
        "handle": "<string>",
        "provider": "<string>",
        "is_primary": true
      }
    ],
    "kind": "<string>",
    "agent": {
      "id": "<string>",
      "name": "<string>"
    },
    "automation": {
      "automation_id": "<string>",
      "installation_id": "<string>",
      "plugin": "<string>"
    },
    "run_id": "<string>",
    "username": "<string>"
  },
  "status_actor_kind": "<string>",
  "status_changed_at": "2023-11-07T05:31:56Z",
  "status_reason": "<string>",
  "status_source": "<string>",
  "trail_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "$schema": "/api/v1/schemas/ReviewCommentJSON.json",
  "agent_verdict": {
    "created_at": "2023-11-07T05:31:56Z",
    "evidence": "<string>",
    "outcome": "resolved",
    "run_id": "<string>",
    "verdict": "fixed"
  },
  "source": {
    "agent": {
      "id": "<string>",
      "name": "<string>"
    },
    "run_id": "<string>"
  }
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

{
  "code": "<string>",
  "detail": "<string>",
  "request_id": "<string>",
  "status": 499,
  "title": "<string>",
  "type": "<string>",
  "$schema": "/api/v1/schemas/ProblemDocument.json"
}

Authorizations

Authorization

string

header

required

OAuth 2.0 authorization code flow.

Path Parameters

repo_id

string

required

number

string

required

review_id

string

required

comment_id

string

required

Body

application/json

body

string | null

Maximum string length: 65536

confidence

number<double> | null

Required range: 0 <= x <= 1

severity

enum<string> | null

Available options:

high,

medium,

low

status

enum<string>

Available options:

open,

resolved,

dismissed

status_reason

string | null

Response

actor_display_name

string | null

required

actor_id

string | null

required

actor_identity

object

required

Who wrote it: kind agent, with agent and run_id, for a finding a saved Agent raised (as in source).

Show child attributes

body

string | null

required

client_id

string | null

required

client_id_hash

string | null

required

code_version_id

string

required

confidence

number<double> | null

required

created_at

string<date-time>

required

discussion_id

string | null

required

discussion_message_count

integer<int64>

required

string

required

location

object

required

Show child attributes

repo_id

string

required

review_id

string

required

severity

string | null

required

stale_checked_at

string<date-time> | null

required

stale_checked_code_version_id

string | null

required

stale_outcome

string

required

status

string

required

status_actor_display_name

string | null

required

status_actor_id

string | null

required

status_actor_identity

object

required

Who resolved or dismissed it: kind agent, with agent and run_id (the run whose verdict closed it), when the agent that raised it closed it.

Show child attributes

status_actor_kind

string | null

required

status_changed_at

string<date-time> | null

required

status_reason

string | null

required

status_source

string | null

required

trail_id

string

required

updated_at

string<date-time>

required

$schema

string<uri>

read-only

A URL to the JSON Schema for this object.

Example:

"/api/v1/schemas/ReviewCommentJSON.json"

agent_verdict

object

The latest verdict the agent that raised this finding gave on it in a later run; absent until one has.

Show child attributes

source

object

The agent run whose review published this finding; absent for every other comment. actor_id stays the publishing principal.

Show child attributes

Documentation

Accounts and projects

Git

Trails

Sessions and checkpoints

Webhooks

Change: Update a review comment (repo_id addressing)

Authorizations

Path Parameters

Body

Response