Skip to content

Commit 0e844ba

Browse files
vdaas-civankichi
vdaas-ci
and
vankichi
authored
📝 Fix format of proto files (#2778) (#2783)
Signed-off-by: vankichi <[email protected]> Co-authored-by: Kiichiro YUKAWA <[email protected]>
1 parent 8537f27 commit 0e844ba

8 files changed

+74
-74
lines changed

‎apis/proto/v1/vald/filter.proto

+6-6
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ option java_package = "org.vdaas.vald.api.v1.vald";
2828

2929
// Overview
3030
// Filter Server is responsible for providing insert, update, upsert and search interface for `Vald Filter Gateway`.
31-
//
31+
//
3232
// Vald Filter Gateway forward user request to user-defined ingress/egress filter components allowing user to run custom logic.
3333
service Filter {
3434
// Overview
@@ -69,7 +69,7 @@ service Filter {
6969

7070
// Overview
7171
// MultiSearchObject RPC is the method to search objects with multiple objects in **1** request.
72-
//
72+
//
7373
// <div class="notice">
7474
// gRPC has a message size limitation.<br>
7575
// Please be careful that the size of the request exceeds the limit.
@@ -103,7 +103,7 @@ service Filter {
103103

104104
// Overview
105105
// StreamInsertObject RPC is the method to add new multiple object using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).
106-
//
106+
//
107107
// By using the bidirectional streaming RPC, the insert request can be communicated in any order between client and server.
108108
// Each Insert request and response are independent.
109109
// It's the recommended method to insert a large number of objects.
@@ -168,14 +168,14 @@ service Filter {
168168

169169
// Overview
170170
// MultiUpdateObject is the method to update multiple objects in **1** request.
171-
//
171+
//
172172
// <div class="notice">
173173
// gRPC has the message size limitation.<br>
174174
// Please be careful that the size of the request exceed the limit.
175175
// </div>
176176
// ---
177177
// Status Code
178-
//
178+
//
179179
// | 0 | OK |
180180
// | 1 | CANCELLED |
181181
// | 3 | INVALID_ARGUMENT |
@@ -220,7 +220,7 @@ service Filter {
220220

221221
// Overview
222222
// MultiUpsertObject is the method to update existing multiple objects and add new multiple objects in **1** request.
223-
//
223+
//
224224
// <div class="notice">
225225
// gRPC has a message size limitation.<br>
226226
// Please be careful that the size of the request exceeds the limit.

‎apis/proto/v1/vald/index.proto

+2-2
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ service Index {
3434
rpc IndexInfo(payload.v1.Empty) returns (payload.v1.Info.Index.Count) {
3535
option (google.api.http).get = "/index/info";
3636
}
37-
37+
3838
// Overview
3939
// Represent the RPC to get the index information for each agents.
4040
rpc IndexDetail(payload.v1.Empty) returns (payload.v1.Info.Index.Detail) {
4141
option (google.api.http).get = "/index/detail";
4242
}
43-
43+
4444
// Overview
4545
// Represent the RPC to get the index statistics.
4646
rpc IndexStatistics(payload.v1.Empty) returns (payload.v1.Info.Index.Statistics) {

‎apis/proto/v1/vald/insert.proto

+6-6
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ service Insert {
4444
// The request process may not be completed when the response code is NOT `0 (OK)`.
4545
//
4646
// Here are some common reasons and how to resolve each error.
47-
//
47+
//
4848
// | name | common reason | how to resolve |
4949
// | :---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
5050
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |
@@ -76,9 +76,9 @@ service Insert {
7676
// ---
7777
// Troubleshooting
7878
// The request process may not be completed when the response code is NOT `0 (OK)`.
79-
//
79+
//
8080
// Here are some common reasons and how to resolve each error.
81-
//
81+
//
8282
// | name | common reason | how to resolve |
8383
// | :---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
8484
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |
@@ -90,7 +90,7 @@ service Insert {
9090

9191
// Overview
9292
// MultiInsert RPC is the method to add multiple new vectors in **1** request.
93-
//
93+
//
9494
// <div class="notice">
9595
// gRPC has a message size limitation.<br>
9696
// Please be careful that the size of the request exceeds the limit.
@@ -107,9 +107,9 @@ service Insert {
107107
// ---
108108
// Troubleshooting
109109
// The request process may not be completed when the response code is NOT `0 (OK)`.
110-
//
110+
//
111111
// Here are some common reasons and how to resolve each error.
112-
//
112+
//
113113
// | name | common reason | how to resolve |
114114
// | :---------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
115115
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |

‎apis/proto/v1/vald/object.proto

+6-6
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ service Object {
4242
// ---
4343
// Troubleshooting
4444
// The request process may not be completed when the response code is NOT `0 (OK)`.
45-
//
45+
//
4646
// Here are some common reasons and how to resolve each error.
47-
//
47+
//
4848
// | name | common reason | how to resolve |
4949
// | :---------------- | :---------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
5050
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |
@@ -69,9 +69,9 @@ service Object {
6969
// ---
7070
// Troubleshooting
7171
// The request process may not be completed when the response code is NOT `0 (OK)`.
72-
//
72+
//
7373
// Here are some common reasons and how to resolve each error.
74-
//
74+
//
7575
// | name | common reason | how to resolve |
7676
// | :---------------- | :---------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
7777
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |
@@ -98,9 +98,9 @@ service Object {
9898
// ---
9999
// Troubleshooting
100100
// The request process may not be completed when the response code is NOT `0 (OK)`.
101-
//
101+
//
102102
// Here are some common reasons and how to resolve each error.
103-
//
103+
//
104104
// | name | common reason | how to resolve |
105105
// | :---------------- | :---------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
106106
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |

‎apis/proto/v1/vald/remove.proto

+12-12
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,9 @@ service Remove {
4343
// ---
4444
// Troubleshooting
4545
// The request process may not be completed when the response code is NOT `0 (OK)`.
46-
//
46+
//
4747
// Here are some common reasons and how to resolve each error.
48-
//
48+
//
4949
// | name | common reason | how to resolve |
5050
// | :---------------- | :---------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
5151
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |
@@ -62,7 +62,7 @@ service Remove {
6262

6363
// Overview
6464
// RemoveByTimestamp RPC is the method to remove vectors based on timestamp.
65-
//
65+
//
6666
// <div class="notice">
6767
// In the TimestampRequest message, the 'timestamps' field is repeated, allowing the inclusion of multiple Timestamp.<br>
6868
// When multiple Timestamps are provided, it results in an `AND` condition, enabling the realization of deletions with specified ranges.<br>
@@ -78,15 +78,15 @@ service Remove {
7878
// ---
7979
// Troubleshooting
8080
// The request process may not be completed when the response code is NOT `0 (OK)`.
81-
//
81+
//
8282
// Here are some common reasons and how to resolve each error.
83-
//
83+
//
8484
// | name | common reason | how to resolve |
8585
// | :---------------- | :---------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------- |
8686
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |
8787
// | DEADLINE_EXCEEDED | The RPC timeout setting is too short on the client/server side. | Check the gRPC timeout setting on both the client and server sides and fix it if needed. |
8888
// | NOT_FOUND | No vectors in the system match the specified timestamp conditions. | Check whether vectors matching the specified timestamp conditions exist in the system, and fix conditions if needed. |
89-
// | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second.
89+
// | INTERNAL | Target Vald cluster or network route has some critical error. | Check target Vald cluster first and check network route including ingress as second.
9090
rpc RemoveByTimestamp(payload.v1.Remove.TimestampRequest) returns (payload.v1.Object.Locations) {
9191
option (google.api.http) = {
9292
post: "/remove/timestamp"
@@ -96,7 +96,7 @@ service Remove {
9696

9797
// Overview
9898
// A method to remove multiple indexed vectors by bidirectional streaming.
99-
//
99+
//
100100
// StreamRemove RPC is the method to remove multiple vectors using the [bidirectional streaming RPC](https://grpc.io/docs/what-is-grpc/core-concepts/#bidirectional-streaming-rpc).<br>
101101
// Using the bidirectional streaming RPC, the remove request can be communicated in any order between client and server.
102102
// Each Remove request and response are independent.
@@ -113,9 +113,9 @@ service Remove {
113113
// ---
114114
// Troubleshooting
115115
// The request process may not be completed when the response code is NOT `0 (OK)`.
116-
//
116+
//
117117
// Here are some common reasons and how to resolve each error.
118-
//
118+
//
119119
// | name | common reason | how to resolve |
120120
// | :---------------- | :---------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
121121
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |
@@ -127,7 +127,7 @@ service Remove {
127127

128128
// Overview
129129
// MultiRemove is the method to remove multiple vectors in **1** request.
130-
//
130+
//
131131
// <div class="notice">
132132
// gRPC has a message size limitation.<br>
133133
// Please be careful that the size of the request exceeds the limit.
@@ -144,9 +144,9 @@ service Remove {
144144
// ---
145145
// Troubleshooting
146146
// The request process may not be completed when the response code is NOT `0 (OK)`.
147-
//
147+
//
148148
// Here are some common reasons and how to resolve each error.
149-
//
149+
//
150150
// | name | common reason | how to resolve |
151151
// | :---------------- | :---------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------- |
152152
// | CANCELLED | Executed cancel() of rpc from client/server-side or network problems between client and server. | Check the code, especially around timeout and connection management, and fix if needed. |

0 commit comments

Comments
 (0)