Skip to content

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

docs(proto): say priority has no bearing on blocking

rebelicebc2adb733e71
diff --git a/backend/generated-go/store/issue_comment.pb.go b/backend/generated-go/store/issue_comment.pb.go
index a3bcabb934..533eac5f12 100644
--- a/backend/generated-go/store/issue_comment.pb.go
+++ b/backend/generated-go/store/issue_comment.pb.go
@@ -21,17 +21,19 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
+// Priority says what resolving the thread means. It has no bearing on
+// blocking: an OPEN root thread blocks whatever its priority, and a
+// result with no thread state never does.
type IssueCommentPayload_ReviewMetadata_Priority int32
const (
- // Blocks like any other open thread.
IssueCommentPayload_ReviewMetadata_PRIORITY_UNSPECIFIED IssueCommentPayload_ReviewMetadata_Priority = 0
// The SQL is wrong and must change. Resolving without changing the SQL
// is a claim of false positive.
IssueCommentPayload_ReviewMetadata_P0 IssueCommentPayload_ReviewMetadata_Priority = 1
// Dangerous but legitimate; a person must accept it.
IssueCommentPayload_ReviewMetadata_P1 IssueCommentPayload_ReviewMetadata_Priority = 2
- // Advisory. Posted without thread state, so it never blocks.
+ // Advisory.
IssueCommentPayload_ReviewMetadata_P2 IssueCommentPayload_ReviewMetadata_Priority = 3
)
@@ -463,8 +465,7 @@ func (x *IssueCommentPayload_PlanUpdate) GetToSpecs() []*PlanConfig_Spec {
// reviewer posted it, what it was judged against, its priority, and the
// databases it applies to. Results from the same reviewer are superseded
// together: when a run completes, it resolves every OPEN root of its type
-// and deletes every P2 of its type, in the transaction that posts the new
-// results.
+// in the transaction that posts the new results.
type IssueCommentPayload_ReviewMetadata struct {
state protoimpl.MessageState `protogen:"open.v1"`
// The reviewer slot that posted the result, same value domain as
diff --git a/backend/generated-go/v1/issue_service.pb.go b/backend/generated-go/v1/issue_service.pb.go
index dfb64f7f3f..158dfd997f 100644
--- a/backend/generated-go/v1/issue_service.pb.go
+++ b/backend/generated-go/v1/issue_service.pb.go
@@ -190,16 +190,17 @@ func (IssueComment_ThreadState) EnumDescriptor() ([]byte, []int) {
return file_v1_issue_service_proto_rawDescGZIP(), []int{21, 0}
}
+// Priority says what resolving the thread means. It has no bearing on
+// blocking, which thread_state alone decides.
type IssueComment_ReviewMetadata_Priority int32
const (
- // Blocks like any other open thread.
IssueComment_ReviewMetadata_PRIORITY_UNSPECIFIED IssueComment_ReviewMetadata_Priority = 0
// The SQL is wrong and must change.
IssueComment_ReviewMetadata_P0 IssueComment_ReviewMetadata_Priority = 1
// Dangerous but legitimate; a person must accept it.
IssueComment_ReviewMetadata_P1 IssueComment_ReviewMetadata_Priority = 2
- // Advisory. Posted without thread state, so it never blocks.
+ // Advisory.
IssueComment_ReviewMetadata_P2 IssueComment_ReviewMetadata_Priority = 3
)
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 e8ec4b9c00..48435b4fef 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
@@ -1100,12 +1100,13 @@ export declare type IssueComment_ReviewMetadata = Message<"bytebase.v1.IssueComm
export declare const IssueComment_ReviewMetadataSchema: GenMessage<IssueComment_ReviewMetadata>;
/**
+ * Priority says what resolving the thread means. It has no bearing on
+ * blocking, which thread_state alone decides.
+ *
* @generated from enum bytebase.v1.IssueComment.ReviewMetadata.Priority
*/
export enum IssueComment_ReviewMetadata_Priority {
/**
- * Blocks like any other open thread.
- *
* @generated from enum value: PRIORITY_UNSPECIFIED = 0;
*/
PRIORITY_UNSPECIFIED = 0,
@@ -1125,7 +1126,7 @@ export enum IssueComment_ReviewMetadata_Priority {
P1 = 2,
/**
- * Advisory. Posted without thread state, so it never blocks.
+ * Advisory.
*
* @generated from enum value: P2 = 3;
*/
diff --git a/frontend/src/types/proto-es/v1/issue_service_pb.js b/frontend/src/types/proto-es/v1/issue_service_pb.js
index 4d10179ac4..cd156177c3 100644
--- a/frontend/src/types/proto-es/v1/issue_service_pb.js
+++ b/frontend/src/types/proto-es/v1/issue_service_pb.js
@@ -224,6 +224,9 @@ export const IssueComment_ReviewMetadata_PrioritySchema = /*@__PURE__*/
enumDesc(file_v1_issue_service, 21, 0, 0);
/**
+ * Priority says what resolving the thread means. It has no bearing on
+ * blocking, which thread_state alone decides.
+ *
* @generated from enum bytebase.v1.IssueComment.ReviewMetadata.Priority
*/
export const IssueComment_ReviewMetadata_Priority = /*@__PURE__*/
diff --git a/proto/gen/grpc-doc/store/README.md b/proto/gen/grpc-doc/store/README.md
index 8c706bd7de..5af1a50051 100644
--- a/proto/gen/grpc-doc/store/README.md
+++ b/proto/gen/grpc-doc/store/README.md
@@ -2236,8 +2236,7 @@ ReviewMetadata is what a review result carries beyond its text: which
reviewer posted it, what it was judged against, its priority, and the
databases it applies to. Results from the same reviewer are superseded
together: when a run completes, it resolves every OPEN root of its type
-and deletes every P2 of its type, in the transaction that posts the new
-results.
+in the transaction that posts the new results.
| Field | Type | Label | Description |
@@ -2287,14 +2286,16 @@ read against the anchored sheet and the current plan, not stored.
<a name="bytebase-store-IssueCommentPayload-ReviewMetadata-Priority"></a>
### IssueCommentPayload.ReviewMetadata.Priority
-
+Priority says what resolving the thread means. It has no bearing on
+blocking: an OPEN root thread blocks whatever its priority, and a
+result with no thread state never does.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| PRIORITY_UNSPECIFIED | 0 | Blocks like any other open thread. |
+| PRIORITY_UNSPECIFIED | 0 | |
| P0 | 1 | The SQL is wrong and must change. Resolving without changing the SQL is a claim of false positive. |
| P1 | 2 | Dangerous but legitimate; a person must accept it. |
-| P2 | 3 | Advisory. Posted without thread state, so it never blocks. |
+| P2 | 3 | Advisory. |
diff --git a/proto/gen/grpc-doc/store/index.html b/proto/gen/grpc-doc/store/index.html
index 1f283011c4..b45f5fbe71 100644
--- a/proto/gen/grpc-doc/store/index.html
+++ b/proto/gen/grpc-doc/store/index.html
@@ -6421,7 +6421,7 @@ change. </p></td>
<h3 id="bytebase.store.IssueCommentPayload.ReviewMetadata">IssueCommentPayload.ReviewMetadata</h3>
- <p>ReviewMetadata is what a review result carries beyond its text: which</p><p>reviewer posted it, what it was judged against, its priority, and the</p><p>databases it applies to. Results from the same reviewer are superseded</p><p>together: when a run completes, it resolves every OPEN root of its type</p><p>and deletes every P2 of its type, in the transaction that posts the new</p><p>results.</p>
+ <p>ReviewMetadata is what a review result carries beyond its text: which</p><p>reviewer posted it, what it was judged against, its priority, and the</p><p>databases it applies to. Results from the same reviewer are superseded</p><p>together: when a run completes, it resolves every OPEN root of its type</p><p>in the transaction that posts the new results.</p>
<table class="field-table">
@@ -6530,7 +6530,7 @@ Setting exactly one column to 0 is invalid. </p></td>
<h3 id="bytebase.store.IssueCommentPayload.ReviewMetadata.Priority">IssueCommentPayload.ReviewMetadata.Priority</h3>
- <p></p>
+ <p>Priority says what resolving the thread means. It has no bearing on</p><p>blocking: an OPEN root thread blocks whatever its priority, and a</p><p>result with no thread state never does.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -6540,7 +6540,7 @@ Setting exactly one column to 0 is invalid. </p></td>
<tr>
<td>PRIORITY_UNSPECIFIED</td>
<td>0</td>
- <td><p>Blocks like any other open thread.</p></td>
+ <td><p></p></td>
</tr>
<tr>
@@ -6559,7 +6559,7 @@ is a claim of false positive.</p></td>
<tr>
<td>P2</td>
<td>3</td>
- <td><p>Advisory. Posted without thread state, so it never blocks.</p></td>
+ <td><p>Advisory.</p></td>
</tr>
</tbody>
diff --git a/proto/gen/grpc-doc/v1/README.md b/proto/gen/grpc-doc/v1/README.md
index 5360f8748a..212d305700 100644
--- a/proto/gen/grpc-doc/v1/README.md
+++ b/proto/gen/grpc-doc/v1/README.md
@@ -4019,14 +4019,15 @@ Approval status values.
<a name="bytebase-v1-IssueComment-ReviewMetadata-Priority"></a>
### IssueComment.ReviewMetadata.Priority
-
+Priority says what resolving the thread means. It has no bearing on
+blocking, which thread_state alone decides.
| Name | Number | Description |
| ---- | ------ | ----------- |
-| PRIORITY_UNSPECIFIED | 0 | Blocks like any other open thread. |
+| PRIORITY_UNSPECIFIED | 0 | |
| P0 | 1 | The SQL is wrong and must change. |
| P1 | 2 | Dangerous but legitimate; a person must accept it. |
-| P2 | 3 | Advisory. Posted without thread state, so it never blocks. |
+| P2 | 3 | Advisory. |
diff --git a/proto/gen/grpc-doc/v1/index.html b/proto/gen/grpc-doc/v1/index.html
index de75d0a8e7..dad8cd40f1 100644
--- a/proto/gen/grpc-doc/v1/index.html
+++ b/proto/gen/grpc-doc/v1/index.html
@@ -11950,7 +11950,7 @@ In this situation, `update_mask` is ignored. </p></td>
</table>
<h3 id="bytebase.v1.IssueComment.ReviewMetadata.Priority">IssueComment.ReviewMetadata.Priority</h3>
- <p></p>
+ <p>Priority says what resolving the thread means. It has no bearing on</p><p>blocking, which thread_state alone decides.</p>
<table class="enum-table">
<thead>
<tr><td>Name</td><td>Number</td><td>Description</td></tr>
@@ -11960,7 +11960,7 @@ In this situation, `update_mask` is ignored. </p></td>
<tr>
<td>PRIORITY_UNSPECIFIED</td>
<td>0</td>
- <td><p>Blocks like any other open thread.</p></td>
+ <td><p></p></td>
</tr>
<tr>
@@ -11978,7 +11978,7 @@ In this situation, `update_mask` is ignored. </p></td>
<tr>
<td>P2</td>
<td>3</td>
- <td><p>Advisory. Posted without thread state, so it never blocks.</p></td>
+ <td><p>Advisory.</p></td>
</tr>
</tbody>
diff --git a/proto/store/store/issue_comment.proto b/proto/store/store/issue_comment.proto
index 9875e57649..771fd47ab3 100644
--- a/proto/store/store/issue_comment.proto
+++ b/proto/store/store/issue_comment.proto
@@ -62,18 +62,19 @@ message IssueCommentPayload {
// reviewer posted it, what it was judged against, its priority, and the
// databases it applies to. Results from the same reviewer are superseded
// together: when a run completes, it resolves every OPEN root of its type
- // and deletes every P2 of its type, in the transaction that posts the new
- // results.
+ // in the transaction that posts the new results.
message ReviewMetadata {
+ // Priority says what resolving the thread means. It has no bearing on
+ // blocking: an OPEN root thread blocks whatever its priority, and a
+ // result with no thread state never does.
enum Priority {
- // Blocks like any other open thread.
PRIORITY_UNSPECIFIED = 0;
// The SQL is wrong and must change. Resolving without changing the SQL
// is a claim of false positive.
P0 = 1;
// Dangerous but legitimate; a person must accept it.
P1 = 2;
- // Advisory. Posted without thread state, so it never blocks.
+ // Advisory.
P2 = 3;
}
diff --git a/proto/v1/v1/issue_service.proto b/proto/v1/v1/issue_service.proto
index 56994f7ff9..3e920b1c98 100644
--- a/proto/v1/v1/issue_service.proto
+++ b/proto/v1/v1/issue_service.proto
@@ -696,14 +696,15 @@ message IssueComment {
// What a review result carries beyond its text.
message ReviewMetadata {
+ // Priority says what resolving the thread means. It has no bearing on
+ // blocking, which thread_state alone decides.
enum Priority {
- // Blocks like any other open thread.
PRIORITY_UNSPECIFIED = 0;
// The SQL is wrong and must change.
P0 = 1;
// Dangerous but legitimate; a person must accept it.
P1 = 2;
- // Advisory. Posted without thread state, so it never blocks.
+ // Advisory.
P2 = 3;
}