Skip to content

Commit 5c41f5e

Browse files
author
phelan
authored
chore(model,connector,billing): rename list message struct with plural (#145)
Because - follow [Google AIP 132](https://google.aip.dev/132), list message uses plural name This commit - update list message struct name
1 parent b239e52 commit 5c41f5e

File tree

11 files changed

+204
-205
lines changed

11 files changed

+204
-205
lines changed

openapiv2/openapiv2.swagger.yaml

Lines changed: 107 additions & 108 deletions
Large diffs are not rendered by default.

vdp/billing/v1alpha/plan.proto

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,8 @@ enum View {
7575
VIEW_FULL = 2;
7676
}
7777

78-
// ListPlanRequest represents a request to list all plans
79-
message ListPlanRequest {
78+
// ListPlansRequest represents a request to list all plans
79+
message ListPlansRequest {
8080
// Page size: the maximum number of resources to return. The service may
8181
// return fewer than this value. If unspecified, at most 10 plans will be
8282
// returned. The maximum value is 100; values above 100 will be coereced to
@@ -90,8 +90,8 @@ message ListPlanRequest {
9090
optional string filter = 4 [ (google.api.field_behavior) = OPTIONAL ];
9191
}
9292

93-
// ListPlanResponse represents a response for a list of plans
94-
message ListPlanResponse {
93+
// ListPlansResponse represents a response for a list of plans
94+
message ListPlansResponse {
9595
// A list of plans
9696
repeated Plan plans = 1;
9797
// Next page token

vdp/billing/v1alpha/plan_service.proto

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,9 @@ service PlanService {
3535

3636
// ========== Admin API: create, get, update and delete billing plans
3737

38-
// ListPlan method receives a ListPlanRequest message and returns a
39-
// ListPlanResponse message.
40-
rpc ListPlan(ListPlanRequest) returns (ListPlanResponse) {
38+
// ListPlans method receives a ListPlansRequest message and returns a
39+
// ListPlansResponse message.
40+
rpc ListPlans(ListPlansRequest) returns (ListPlansResponse) {
4141
option (google.api.http) = {
4242
get : "/v1alpha/admin/plans"
4343
};

vdp/connector/v1alpha/connector.proto

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -138,9 +138,9 @@ message CreateSourceConnectorResponse {
138138
SourceConnector source_connector = 1;
139139
}
140140

141-
// ListSourceConnectorRequest represents a request to list
141+
// ListSourceConnectorsRequest represents a request to list
142142
// SourceConnector resources
143-
message ListSourceConnectorRequest {
143+
message ListSourceConnectorsRequest {
144144
// The maximum number of connectors to return. The service may return fewer
145145
// than this value. If unspecified, at most 10 connectors will be returned.
146146
// The maximum value is 100; values above 100 will be coerced to 100.
@@ -151,9 +151,9 @@ message ListSourceConnectorRequest {
151151
optional View view = 3 [ (google.api.field_behavior) = OPTIONAL ];
152152
}
153153

154-
// ListSourceConnectorResponse represents a response for a list of
154+
// ListSourceConnectorsResponse represents a response for a list of
155155
// SourceConnector resources
156-
message ListSourceConnectorResponse {
156+
message ListSourceConnectorsResponse {
157157
// A list of SourceConnector resources
158158
repeated SourceConnector source_connectors = 1;
159159
// Next page token
@@ -338,9 +338,9 @@ message CreateDestinationConnectorResponse {
338338
DestinationConnector destination_connector = 1;
339339
}
340340

341-
// ListDestinationConnectorRequest represents a request to list
341+
// ListDestinationConnectorsRequest represents a request to list
342342
// DestinationConnector resources
343-
message ListDestinationConnectorRequest {
343+
message ListDestinationConnectorsRequest {
344344
// The maximum number of connectors to return. The service may return fewer
345345
// than this value. If unspecified, at most 10 connectors will be returned.
346346
// The maximum value is 100; values above 100 will be coerced to 100.
@@ -351,9 +351,9 @@ message ListDestinationConnectorRequest {
351351
optional View view = 3 [ (google.api.field_behavior) = OPTIONAL ];
352352
}
353353

354-
// ListDestinationConnectorResponse represents a response for a list of
354+
// ListDestinationConnectorsResponse represents a response for a list of
355355
// DestinationConnector resources
356-
message ListDestinationConnectorResponse {
356+
message ListDestinationConnectorsResponse {
357357
// A list of DestinationConnector resources
358358
repeated DestinationConnector destination_connectors = 1;
359359
// Next page token
@@ -545,9 +545,9 @@ message WriteDestinationConnectorResponse {}
545545

546546
// ========== Admin endpoints
547547

548-
// ListSourceConnectorAdminRequest represents a request to list
548+
// ListSourceConnectorsAdminRequest represents a request to list
549549
// SourceConnector resources from all users by admin
550-
message ListSourceConnectorAdminRequest {
550+
message ListSourceConnectorsAdminRequest {
551551
// The maximum number of connectors to return. The service may return fewer
552552
// than this value. If unspecified, at most 10 connectors will be returned.
553553
// The maximum value is 100; values above 100 will be coerced to 100.
@@ -558,9 +558,9 @@ message ListSourceConnectorAdminRequest {
558558
optional View view = 3 [ (google.api.field_behavior) = OPTIONAL ];
559559
}
560560

561-
// ListSourceConnectorAdminResponse represents a response for a list of
561+
// ListSourceConnectorsAdminResponse represents a response for a list of
562562
// SourceConnector resources
563-
message ListSourceConnectorAdminResponse {
563+
message ListSourceConnectorsAdminResponse {
564564
// A list of SourceConnector resources
565565
repeated SourceConnector source_connectors = 1;
566566
// Next page token
@@ -610,9 +610,9 @@ message LookUpSourceConnectorAdminResponse {
610610
SourceConnector source_connector = 1;
611611
}
612612

613-
// ListDestinationConnectorAdminRequest represents a request to list
613+
// ListDestinationConnectorsAdminRequest represents a request to list
614614
// DestinationConnector resources from all users by admin
615-
message ListDestinationConnectorAdminRequest {
615+
message ListDestinationConnectorsAdminRequest {
616616
// The maximum number of connectors to return. The service may return fewer
617617
// than this value. If unspecified, at most 10 connectors will be returned.
618618
// The maximum value is 100; values above 100 will be coerced to 100.
@@ -623,9 +623,9 @@ message ListDestinationConnectorAdminRequest {
623623
optional View view = 3 [ (google.api.field_behavior) = OPTIONAL ];
624624
}
625625

626-
// ListDestinationConnectorAdminResponse represents a response for a list of
626+
// ListDestinationConnectorsAdminResponse represents a response for a list of
627627
// DestinationConnector resources
628-
message ListDestinationConnectorAdminResponse {
628+
message ListDestinationConnectorsAdminResponse {
629629
// A list of DestinationConnector resources
630630
repeated DestinationConnector destination_connectors = 1;
631631
// Next page token

vdp/connector/v1alpha/connector_definition.proto

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -154,9 +154,9 @@ message DestinationConnectorDefinition {
154154

155155
// SourceConnectorDefinition
156156
//
157-
// ListSourceConnectorDefinitionRequest represents a request to list
157+
// ListSourceConnectorDefinitionsRequest represents a request to list
158158
// SourceConnectorDefinitions
159-
message ListSourceConnectorDefinitionRequest {
159+
message ListSourceConnectorDefinitionsRequest {
160160
// The maximum number of SourceConnectorDefinitions to return. The service may
161161
// return fewer than this value. If unspecified, at most 10
162162
// SourceConnectorDefinitions will be returned. The maximum value is 100;
@@ -168,9 +168,9 @@ message ListSourceConnectorDefinitionRequest {
168168
optional View view = 3 [ (google.api.field_behavior) = OPTIONAL ];
169169
}
170170

171-
// ListSourceConnectorDefinitionResponse represents a response for a list of
171+
// ListSourceConnectorDefinitionsResponse represents a response for a list of
172172
// SourceConnectorDefinitions
173-
message ListSourceConnectorDefinitionResponse {
173+
message ListSourceConnectorDefinitionsResponse {
174174
// A list of SourceConnectorDefinition resources
175175
repeated SourceConnectorDefinition source_connector_definitions = 1;
176176
// Next page token
@@ -209,9 +209,9 @@ message GetSourceConnectorDefinitionResponse {
209209
///////////////////////////////////////////////////////////////////////
210210
// DestinationConnectorDefinition
211211
//
212-
// ListDestinationConnectorDefinitionRequest represents a request to list
212+
// ListDestinationConnectorDefinitionsRequest represents a request to list
213213
// DestinationConnectorDefinitions
214-
message ListDestinationConnectorDefinitionRequest {
214+
message ListDestinationConnectorDefinitionsRequest {
215215
// The maximum number of DestinationConnectorDefinitions to return. The
216216
// service may return fewer than this value. If unspecified, at most 10
217217
// DestinationConnectorDefinitions will be returned. The maximum value is 100;
@@ -223,9 +223,9 @@ message ListDestinationConnectorDefinitionRequest {
223223
optional View view = 3 [ (google.api.field_behavior) = OPTIONAL ];
224224
}
225225

226-
// ListDestinationConnectorDefinitionResponse represents a response for a list
226+
// ListDestinationConnectorDefinitionsResponse represents a response for a list
227227
// of DestinationConnectorDefinitions
228-
message ListDestinationConnectorDefinitionResponse {
228+
message ListDestinationConnectorDefinitionsResponse {
229229
// A list of DestinationConnectorDefinition resources
230230
repeated DestinationConnectorDefinition destination_connector_definitions = 1;
231231
// Next page token

vdp/connector/v1alpha/connector_private_service.proto

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ service ConnectorPrivateService {
1313

1414
// *SourceConnector methods
1515

16-
// ListSourceConnectorAdmin method receives a ListSourceConnectorAdminRequest
17-
// message and returns a ListSourceConnectorAdminResponse message.
18-
rpc ListSourceConnectorAdmin(ListSourceConnectorAdminRequest)
19-
returns (ListSourceConnectorAdminResponse) {
16+
// ListSourceConnectorsAdmin method receives a ListSourceConnectorsAdminRequest message
17+
// and returns a ListSourceConnectorsAdminResponse message.
18+
rpc ListSourceConnectorsAdmin(ListSourceConnectorsAdminRequest)
19+
returns (ListSourceConnectorsAdminResponse) {
2020
option (google.api.http) = {
2121
get : "/v1alpha/admin/source-connectors"
2222
};
@@ -45,11 +45,10 @@ service ConnectorPrivateService {
4545

4646
// *DestinationConnector methods
4747

48-
// ListDestinationConnectorAdmin method receives a
49-
// ListDestinationConnectorAdminRequest message and returns a
50-
// ListDestinationConnectorResponse message.
51-
rpc ListDestinationConnectorAdmin(ListDestinationConnectorAdminRequest)
52-
returns (ListDestinationConnectorAdminResponse) {
48+
// ListDestinationConnectorsAdmin method receives a ListDestinationConnectorsAdminRequest
49+
// message and returns a ListDestinationConnectorsResponse message.
50+
rpc ListDestinationConnectorsAdmin(ListDestinationConnectorsAdminRequest)
51+
returns (ListDestinationConnectorsAdminResponse) {
5352
option (google.api.http) = {
5453
get : "/v1alpha/admin/destination-connectors"
5554
};

vdp/connector/v1alpha/connector_public_service.proto

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ service ConnectorPublicService {
3737
};
3838
}
3939

40-
// ListSourceConnectorDefinition method receives a
41-
// ListSourceConnectorDefinitionRequest message and returns a
42-
// ListSourceConnectorDefinitionResponse message.
43-
rpc ListSourceConnectorDefinition(ListSourceConnectorDefinitionRequest)
44-
returns (ListSourceConnectorDefinitionResponse) {
40+
// ListSourceConnectorDefinitions method receives a
41+
// ListSourceConnectorDefinitionsRequest message and returns a
42+
// ListSourceConnectorDefinitionsResponse message.
43+
rpc ListSourceConnectorDefinitions(ListSourceConnectorDefinitionsRequest)
44+
returns (ListSourceConnectorDefinitionsResponse) {
4545
option (google.api.http) = {
4646
get : "/v1alpha/source-connector-definitions"
4747
};
@@ -58,12 +58,12 @@ service ConnectorPublicService {
5858
option (google.api.method_signature) = "name";
5959
}
6060

61-
// ListDestinationConnectorDefinition method receives a
62-
// ListDestinationConnectorDefinitionRequest message and returns a
63-
// ListDestinationConnectorDefinitionResponse message.
64-
rpc ListDestinationConnectorDefinition(
65-
ListDestinationConnectorDefinitionRequest)
66-
returns (ListDestinationConnectorDefinitionResponse) {
61+
// ListDestinationConnectorDefinitions method receives a
62+
// ListDestinationConnectorDefinitionsRequest message and returns a
63+
// ListDestinationConnectorDefinitionsResponse message.
64+
rpc ListDestinationConnectorDefinitions(
65+
ListDestinationConnectorDefinitionsRequest)
66+
returns (ListDestinationConnectorDefinitionsResponse) {
6767
option (google.api.http) = {
6868
get : "/v1alpha/destination-connector-definitions"
6969
};
@@ -98,10 +98,10 @@ service ConnectorPublicService {
9898
option (google.api.method_signature) = "source_connector";
9999
}
100100

101-
// ListSourceConnector method receives a ListSourceConnectorRequest message
102-
// and returns a ListSourceConnectorResponse message.
103-
rpc ListSourceConnector(ListSourceConnectorRequest)
104-
returns (ListSourceConnectorResponse) {
101+
// ListSourceConnectors method receives a ListSourceConnectorsRequest message
102+
// and returns a ListSourceConnectorsResponse message.
103+
rpc ListSourceConnectors(ListSourceConnectorsRequest)
104+
returns (ListSourceConnectorsResponse) {
105105
option (google.api.http) = {
106106
get : "/v1alpha/source-connectors"
107107
};
@@ -212,10 +212,10 @@ service ConnectorPublicService {
212212
option (google.api.method_signature) = "destination_connector";
213213
}
214214

215-
// ListDestinationConnector method receives a ListDestinationConnectorRequest
216-
// message and returns a ListDestinationConnectorResponse message.
217-
rpc ListDestinationConnector(ListDestinationConnectorRequest)
218-
returns (ListDestinationConnectorResponse) {
215+
// ListDestinationConnectors method receives a ListDestinationConnectorsRequest
216+
// message and returns a ListDestinationConnectorsResponse message.
217+
rpc ListDestinationConnectors(ListDestinationConnectorsRequest)
218+
returns (ListDestinationConnectorsResponse) {
219219
option (google.api.http) = {
220220
get : "/v1alpha/destination-connectors"
221221
};

vdp/model/v1alpha/model.proto

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -179,8 +179,8 @@ message ModelInstanceCard {
179179
string encoding = 5 [ (google.api.field_behavior) = OUTPUT_ONLY ];
180180
}
181181

182-
// ListModelRequest represents a request to list all models
183-
message ListModelRequest {
182+
// ListModelsRequest represents a request to list all models
183+
message ListModelsRequest {
184184
// Page size: the maximum number of resources to return. The service may
185185
// return fewer than this value. If unspecified, at most 10 models will be
186186
// returned. The maximum value is 100; values above 100 will be coereced to
@@ -194,8 +194,8 @@ message ListModelRequest {
194194
optional View view = 3 [ (google.api.field_behavior) = OPTIONAL ];
195195
}
196196

197-
// ListModelResponse represents a response for a list of models
198-
message ListModelResponse {
197+
// ListModelsResponse represents a response for a list of models
198+
message ListModelsResponse {
199199
// a list of Models
200200
repeated Model models = 1;
201201
// Next page token
@@ -364,9 +364,9 @@ message UnpublishModelResponse {
364364
Model model = 1;
365365
}
366366

367-
// ListModelInstanceRequest represents a request to list all instances of a
367+
// ListModelInstancesRequest represents a request to list all instances of a
368368
// model
369-
message ListModelInstanceRequest {
369+
message ListModelInstancesRequest {
370370
// The name of the model whose instances we'd like to list.
371371
// e.g., "models/yolov4"
372372
string parent = 1 [
@@ -387,8 +387,8 @@ message ListModelInstanceRequest {
387387
optional View view = 4 [ (google.api.field_behavior) = OPTIONAL ];
388388
}
389389

390-
// ListModelInstanceResponse represents a response for a list of model instances
391-
message ListModelInstanceResponse {
390+
// ListModelInstancesResponse represents a response for a list of model instances
391+
message ListModelInstancesResponse {
392392
// a list of Model instances
393393
repeated ModelInstance instances = 1;
394394
// Next page token
@@ -685,9 +685,9 @@ message GetModelOperationResponse {
685685
google.longrunning.Operation operation = 1;
686686
}
687687

688-
// ListModelOperationRequest represents a request to list all model operations
688+
// ListModelOperationsRequest represents a request to list all model operations
689689
// including deploy and undeploy
690-
message ListModelOperationRequest {
690+
message ListModelOperationsRequest {
691691
// Page size: the maximum number of resources to return. The service may
692692
// return fewer than this value. If unspecified, at most 10 operations will be
693693
// returned. The maximum value is 100; values above 100 will be coereced to
@@ -703,9 +703,9 @@ message ListModelOperationRequest {
703703
optional View view = 4 [ (google.api.field_behavior) = OPTIONAL ];
704704
}
705705

706-
// ListModelOperationResponse represents a response for a list of model
706+
// ListModelOperationsResponse represents a response for a list of model
707707
// operations including deploy and undeploy
708-
message ListModelOperationResponse {
708+
message ListModelOperationsResponse {
709709
// a list of model operations
710710
repeated google.longrunning.Operation operations = 1;
711711
// Next page token
@@ -726,8 +726,8 @@ message CancelModelOperationResponse {}
726726

727727
// ========== Admin endpoints
728728

729-
// ListModelAdminRequest represents a request to list all models from all users by admin
730-
message ListModelAdminRequest {
729+
// ListModelsAdminRequest represents a request to list all models from all users by admin
730+
message ListModelsAdminRequest {
731731
// Page size: the maximum number of resources to return. The service may
732732
// return fewer than this value. If unspecified, at most 10 models will be
733733
// returned. The maximum value is 100; values above 100 will be coereced to
@@ -741,8 +741,8 @@ message ListModelAdminRequest {
741741
optional View view = 3 [ (google.api.field_behavior) = OPTIONAL ];
742742
}
743743

744-
// ListModelAdminResponse represents a response for a list of models
745-
message ListModelAdminResponse {
744+
// ListModelsAdminResponse represents a response for a list of models
745+
message ListModelsAdminResponse {
746746
// a list of Models
747747
repeated Model models = 1;
748748
// Next page token

vdp/model/v1alpha/model_definition.proto

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -87,9 +87,9 @@ enum View {
8787
VIEW_FULL = 2;
8888
}
8989

90-
// ListModelDefinitionRequest represents a request to list all supported model
90+
// ListModelDefinitionsRequest represents a request to list all supported model
9191
// definitions
92-
message ListModelDefinitionRequest {
92+
message ListModelDefinitionsRequest {
9393
// Page size: the maximum number of resources to return. The service may
9494
// return fewer than this value. If unspecified, at most 10 ModelDefinitions
9595
// will be returned. The maximum value is 100; values above 100 will be
@@ -104,9 +104,9 @@ message ListModelDefinitionRequest {
104104
optional View view = 3 [ (google.api.field_behavior) = OPTIONAL ];
105105
}
106106

107-
// ListModelDefinitionResponse represents a response to list all supported model
107+
// ListModelDefinitionsResponse represents a response to list all supported model
108108
// definitions
109-
message ListModelDefinitionResponse {
109+
message ListModelDefinitionsResponse {
110110
// a list of ModelDefinition instances
111111
repeated ModelDefinition model_definitions = 1;
112112
// Next page token

0 commit comments

Comments
 (0)