Skip to content

Database governance built for humans and agents — controlling changes and access across every major database.

docs(proto): say where RunReview results surface

rebelice9745a1330f24
diff --git a/backend/api/mcp/gen/openapi.yaml b/backend/api/mcp/gen/openapi.yaml
index 0c3a5df167..5565526826 100644
--- a/backend/api/mcp/gen/openapi.yaml
+++ b/backend/api/mcp/gen/openapi.yaml
@@ -3107,6 +3107,9 @@ paths:
Triggers a review run. The slot is reset unconditionally: a RUNNING
execution is superseded (its completion is fenced off), the attempt
number is bumped, and the returned run is AVAILABLE.
+ Review results are not returned by this RPC and have no read RPC yet:
+ findings will surface as issue comments once the review comment
+ integration lands. The returned run carries execution status only.
The audit log is the only record of who triggered a run.
Permissions required: bb.reviewRuns.run
operationId: bytebase.v1.IssueService.RunReview
diff --git a/backend/generated-go/v1/issue_service_grpc.pb.go b/backend/generated-go/v1/issue_service_grpc.pb.go
index 3f6731d39c..cb86090008 100644
--- a/backend/generated-go/v1/issue_service_grpc.pb.go
+++ b/backend/generated-go/v1/issue_service_grpc.pb.go
@@ -90,6 +90,9 @@ type IssueServiceClient interface {
// Triggers a review run. The slot is reset unconditionally: a RUNNING
// execution is superseded (its completion is fenced off), the attempt
// number is bumped, and the returned run is AVAILABLE.
+ // Review results are not returned by this RPC and have no read RPC yet:
+ // findings will surface as issue comments once the review comment
+ // integration lands. The returned run carries execution status only.
// The audit log is the only record of who triggered a run.
// Permissions required: bb.reviewRuns.run
RunReview(ctx context.Context, in *RunReviewRequest, opts ...grpc.CallOption) (*ReviewRun, error)
@@ -298,6 +301,9 @@ type IssueServiceServer interface {
// Triggers a review run. The slot is reset unconditionally: a RUNNING
// execution is superseded (its completion is fenced off), the attempt
// number is bumped, and the returned run is AVAILABLE.
+ // Review results are not returned by this RPC and have no read RPC yet:
+ // findings will surface as issue comments once the review comment
+ // integration lands. The returned run carries execution status only.
// The audit log is the only record of who triggered a run.
// Permissions required: bb.reviewRuns.run
RunReview(context.Context, *RunReviewRequest) (*ReviewRun, error)
diff --git a/backend/generated-go/v1/v1connect/issue_service.connect.go b/backend/generated-go/v1/v1connect/issue_service.connect.go
index fc9e075440..20d7c99c34 100644
--- a/backend/generated-go/v1/v1connect/issue_service.connect.go
+++ b/backend/generated-go/v1/v1connect/issue_service.connect.go
@@ -125,6 +125,9 @@ type IssueServiceClient interface {
// Triggers a review run. The slot is reset unconditionally: a RUNNING
// execution is superseded (its completion is fenced off), the attempt
// number is bumped, and the returned run is AVAILABLE.
+ // Review results are not returned by this RPC and have no read RPC yet:
+ // findings will surface as issue comments once the review comment
+ // integration lands. The returned run carries execution status only.
// The audit log is the only record of who triggered a run.
// Permissions required: bb.reviewRuns.run
RunReview(context.Context, *connect.Request[v1.RunReviewRequest]) (*connect.Response[v1.ReviewRun], error)
@@ -367,6 +370,9 @@ type IssueServiceHandler interface {
// Triggers a review run. The slot is reset unconditionally: a RUNNING
// execution is superseded (its completion is fenced off), the attempt
// number is bumped, and the returned run is AVAILABLE.
+ // Review results are not returned by this RPC and have no read RPC yet:
+ // findings will surface as issue comments once the review comment
+ // integration lands. The returned run carries execution status only.
// The audit log is the only record of who triggered a run.
// Permissions required: bb.reviewRuns.run
RunReview(context.Context, *connect.Request[v1.RunReviewRequest]) (*connect.Response[v1.ReviewRun], error)
diff --git a/frontend/src/types/proto-es/v1/issue_service_pb.d.ts b/frontend/src/types/proto-es/v1/issue_service_pb.d.ts
index 6946298319..8d650bb53a 100644
--- a/frontend/src/types/proto-es/v1/issue_service_pb.d.ts
+++ b/frontend/src/types/proto-es/v1/issue_service_pb.d.ts
@@ -1471,6 +1471,9 @@ export declare const IssueService: GenService<{
* Triggers a review run. The slot is reset unconditionally: a RUNNING
* execution is superseded (its completion is fenced off), the attempt
* number is bumped, and the returned run is AVAILABLE.
+ * Review results are not returned by this RPC and have no read RPC yet:
+ * findings will surface as issue comments once the review comment
+ * integration lands. The returned run carries execution status only.
* The audit log is the only record of who triggered a run.
* Permissions required: bb.reviewRuns.run
*
diff --git a/proto/gen/grpc-doc/openapi.yaml b/proto/gen/grpc-doc/openapi.yaml
index 6d1c798a7b..27557a532f 100644
--- a/proto/gen/grpc-doc/openapi.yaml
+++ b/proto/gen/grpc-doc/openapi.yaml
@@ -11240,6 +11240,9 @@ paths:
Triggers a review run. The slot is reset unconditionally: a RUNNING
execution is superseded (its completion is fenced off), the attempt
number is bumped, and the returned run is AVAILABLE.
+ Review results are not returned by this RPC and have no read RPC yet:
+ findings will surface as issue comments once the review comment
+ integration lands. The returned run carries execution status only.
The audit log is the only record of who triggered a run.
Permissions required: bb.reviewRuns.run
operationId: IssueService_RunReview
diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.md
index a8f230efc4..b5926686dc 100644
--- a/proto/gen/grpc-doc/v1/README.md
+++ b/proto/gen/grpc-doc/v1/README.md
@@ -4507,7 +4507,7 @@ IssueService manages issues for tracking database changes and tasks.
| RejectIssue | [RejectIssueRequest](#bytebase-v1-RejectIssueRequest) | [Issue](#bytebase-v1-Issue) | Rejects an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow) |
| RequestIssue | [RequestIssueRequest](#bytebase-v1-RequestIssueRequest) | [Issue](#bytebase-v1-Issue) | Requests changes on an issue. Access determined by approval flow configuration - caller must be a designated approver for the current approval step. Permissions required: None (determined by approval flow) |
| RetryIssueApproval | [RetryIssueApprovalRequest](#bytebase-v1-RetryIssueApprovalRequest) | [Issue](#bytebase-v1-Issue) | Re-runs approval-template finding for an issue stuck in CHECKING. Useful when the synchronous post-create finding errored (e.g. against a malformed workspace approval rule) and the operator has since corrected it — without this, the issue would remain in CHECKING indefinitely because there is no other retry path for non-DATABASE_CHANGE issue types. Idempotent: returns the existing issue unchanged when approval-finding has already completed. Permissions required: None (caller must be the issue creator; mirrors RequestIssue&#39;s authorization model). |
-| RunReview | [RunReviewRequest](#bytebase-v1-RunReviewRequest) | [ReviewRun](#bytebase-v1-ReviewRun) | Triggers a review run. The slot is reset unconditionally: a RUNNING execution is superseded (its completion is fenced off), the attempt number is bumped, and the returned run is AVAILABLE. The audit log is the only record of who triggered a run. Permissions required: bb.reviewRuns.run |
+| RunReview | [RunReviewRequest](#bytebase-v1-RunReviewRequest) | [ReviewRun](#bytebase-v1-ReviewRun) | Triggers a review run. The slot is reset unconditionally: a RUNNING execution is superseded (its completion is fenced off), the attempt number is bumped, and the returned run is AVAILABLE. Review results are not returned by this RPC and have no read RPC yet: findings will surface as issue comments once the review comment integration lands. The returned run carries execution status only. The audit log is the only record of who triggered a run. Permissions required: bb.reviewRuns.run |
diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.html
index 81bc927cfa..e78792be6b 100644
--- a/proto/gen/grpc-doc/v1/index.html
+++ b/proto/gen/grpc-doc/v1/index.html
@@ -13249,6 +13249,9 @@ mirrors RequestIssue&#39;s authorization model).</p></td>
<td><p>Triggers a review run. The slot is reset unconditionally: a RUNNING
execution is superseded (its completion is fenced off), the attempt
number is bumped, and the returned run is AVAILABLE.
+Review results are not returned by this RPC and have no read RPC yet:
+findings will surface as issue comments once the review comment
+integration lands. The returned run carries execution status only.
The audit log is the only record of who triggered a run.
Permissions required: bb.reviewRuns.run</p></td>
</tr>
diff --git a/proto/v1/v1/issue_service.proto b/proto/v1/v1/issue_service.proto
index 6b5e1717cf..11fc7a5254 100644
--- a/proto/v1/v1/issue_service.proto
+++ b/proto/v1/v1/issue_service.proto
@@ -227,6 +227,9 @@ service IssueService {
// Triggers a review run. The slot is reset unconditionally: a RUNNING
// execution is superseded (its completion is fenced off), the attempt
// number is bumped, and the returned run is AVAILABLE.
+ // Review results are not returned by this RPC and have no read RPC yet:
+ // findings will surface as issue comments once the review comment
+ // integration lands. The returned run carries execution status only.
// The audit log is the only record of who triggered a run.
// Permissions required: bb.reviewRuns.run
rpc RunReview(RunReviewRequest) returns (ReviewRun) {