-
Notifications
You must be signed in to change notification settings - Fork 33
/
registry_service.proto
1157 lines (1016 loc) · 40 KB
/
registry_service.proto
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2021 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
syntax = "proto3";
package google.cloud.apigeeregistry.v1;
import "google/api/annotations.proto";
import "google/api/client.proto";
import "google/api/field_behavior.proto";
import "google/api/httpbody.proto";
import "google/api/resource.proto";
import "google/cloud/apigeeregistry/v1/registry_models.proto";
import "google/protobuf/empty.proto";
import "google/protobuf/field_mask.proto";
option go_package = "github.com/apigee/registry/rpc;rpc";
option java_multiple_files = true;
option java_outer_classname = "RegistryServiceProto";
option java_package = "com.google.cloud.apigeeregistry.v1";
// The Registry service allows teams to manage descriptions of APIs.
service Registry {
option (google.api.default_host) = "apigeeregistry.googleapis.com";
// ListApis returns matching APIs.
rpc ListApis(ListApisRequest) returns (ListApisResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/apis"
};
option (google.api.method_signature) = "parent";
}
// GetApi returns a specified API.
rpc GetApi(GetApiRequest) returns (Api) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/apis/*}"
};
option (google.api.method_signature) = "name";
}
// CreateApi creates a specified API.
rpc CreateApi(CreateApiRequest) returns (Api) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/apis"
body: "api"
};
option (google.api.method_signature) = "parent,api,api_id";
}
// UpdateApi can be used to modify a specified API.
rpc UpdateApi(UpdateApiRequest) returns (Api) {
option (google.api.http) = {
patch: "/v1/{api.name=projects/*/locations/*/apis/*}"
body: "api"
};
option (google.api.method_signature) = "api,update_mask";
}
// DeleteApi removes a specified API and all of the resources that it
// owns.
rpc DeleteApi(DeleteApiRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/apis/*}"
};
option (google.api.method_signature) = "name";
}
// ListApiVersions returns matching versions.
rpc ListApiVersions(ListApiVersionsRequest) returns (ListApiVersionsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/apis/*}/versions"
};
option (google.api.method_signature) = "parent";
}
// GetApiVersion returns a specified version.
rpc GetApiVersion(GetApiVersionRequest) returns (ApiVersion) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/apis/*/versions/*}"
};
option (google.api.method_signature) = "name";
}
// CreateApiVersion creates a specified version.
rpc CreateApiVersion(CreateApiVersionRequest) returns (ApiVersion) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/apis/*}/versions"
body: "api_version"
};
option (google.api.method_signature) = "parent,api_version,api_version_id";
}
// UpdateApiVersion can be used to modify a specified version.
rpc UpdateApiVersion(UpdateApiVersionRequest) returns (ApiVersion) {
option (google.api.http) = {
patch: "/v1/{api_version.name=projects/*/locations/*/apis/*/versions/*}"
body: "api_version"
};
option (google.api.method_signature) = "api_version,update_mask";
}
// DeleteApiVersion removes a specified version and all of the resources that
// it owns.
rpc DeleteApiVersion(DeleteApiVersionRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/apis/*/versions/*}"
};
option (google.api.method_signature) = "name";
}
// ListApiSpecs returns matching specs.
rpc ListApiSpecs(ListApiSpecsRequest) returns (ListApiSpecsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/apis/*/versions/*}/specs"
};
option (google.api.method_signature) = "parent";
}
// GetApiSpec returns a specified spec.
rpc GetApiSpec(GetApiSpecRequest) returns (ApiSpec) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*}"
};
option (google.api.method_signature) = "name";
}
// GetApiSpecContents returns the contents of a specified spec.
// If specs are stored with GZip compression, the default behavior
// is to return the spec uncompressed (the mime_type response field
// indicates the exact format returned).
rpc GetApiSpecContents(GetApiSpecContentsRequest) returns (google.api.HttpBody) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*}:getContents"
};
option (google.api.method_signature) = "name";
}
// CreateApiSpec creates a specified spec.
rpc CreateApiSpec(CreateApiSpecRequest) returns (ApiSpec) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/apis/*/versions/*}/specs"
body: "api_spec"
};
option (google.api.method_signature) = "parent,api_spec,api_spec_id";
}
// UpdateApiSpec can be used to modify a specified spec.
rpc UpdateApiSpec(UpdateApiSpecRequest) returns (ApiSpec) {
option (google.api.http) = {
patch: "/v1/{api_spec.name=projects/*/locations/*/apis/*/versions/*/specs/*}"
body: "api_spec"
};
option (google.api.method_signature) = "api_spec,update_mask";
}
// DeleteApiSpec removes a specified spec, all revisions, and all child
// resources (e.g. artifacts).
rpc DeleteApiSpec(DeleteApiSpecRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*}"
};
option (google.api.method_signature) = "name";
}
// TagApiSpecRevision adds a tag to a specified revision of a spec.
rpc TagApiSpecRevision(TagApiSpecRevisionRequest) returns (ApiSpec) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*}:tagRevision"
body: "*"
};
}
// ListApiSpecRevisions lists all revisions of a spec.
// Revisions are returned in descending order of revision creation time.
rpc ListApiSpecRevisions(ListApiSpecRevisionsRequest) returns (ListApiSpecRevisionsResponse) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*}:listRevisions"
};
}
// RollbackApiSpec sets the current revision to a specified prior revision.
// Note that this creates a new revision with a new revision ID.
rpc RollbackApiSpec(RollbackApiSpecRequest) returns (ApiSpec) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*}:rollback"
body: "*"
};
}
// DeleteApiSpecRevision deletes a revision of a spec.
rpc DeleteApiSpecRevision(DeleteApiSpecRevisionRequest) returns (ApiSpec) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*}:deleteRevision"
};
option (google.api.method_signature) = "name";
}
// ListApiDeployments returns matching deployments.
rpc ListApiDeployments(ListApiDeploymentsRequest) returns (ListApiDeploymentsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*/apis/*}/deployments"
};
option (google.api.method_signature) = "parent";
}
// GetApiDeployment returns a specified deployment.
rpc GetApiDeployment(GetApiDeploymentRequest) returns (ApiDeployment) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/apis/*/deployments/*}"
};
option (google.api.method_signature) = "name";
}
// CreateApiDeployment creates a specified deployment.
rpc CreateApiDeployment(CreateApiDeploymentRequest) returns (ApiDeployment) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*/apis/*}/deployments"
body: "api_deployment"
};
option (google.api.method_signature) = "parent,api_deployment,api_deployment_id";
}
// UpdateApiDeployment can be used to modify a specified deployment.
rpc UpdateApiDeployment(UpdateApiDeploymentRequest) returns (ApiDeployment) {
option (google.api.http) = {
patch: "/v1/{api_deployment.name=projects/*/locations/*/apis/*/deployments/*}"
body: "api_deployment"
};
option (google.api.method_signature) = "api_deployment,update_mask";
}
// DeleteApiDeployment removes a specified deployment, all revisions, and all
// child resources (e.g. artifacts).
rpc DeleteApiDeployment(DeleteApiDeploymentRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/apis/*/deployments/*}"
};
option (google.api.method_signature) = "name";
}
// TagApiDeploymentRevision adds a tag to a specified revision of a
// deployment.
rpc TagApiDeploymentRevision(TagApiDeploymentRevisionRequest) returns (ApiDeployment) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/apis/*/deployments/*}:tagRevision"
body: "*"
};
}
// ListApiDeploymentRevisions lists all revisions of a deployment.
// Revisions are returned in descending order of revision creation time.
rpc ListApiDeploymentRevisions(ListApiDeploymentRevisionsRequest) returns (ListApiDeploymentRevisionsResponse) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/apis/*/deployments/*}:listRevisions"
};
}
// RollbackApiDeployment sets the current revision to a specified prior
// revision. Note that this creates a new revision with a new revision ID.
rpc RollbackApiDeployment(RollbackApiDeploymentRequest) returns (ApiDeployment) {
option (google.api.http) = {
post: "/v1/{name=projects/*/locations/*/apis/*/deployments/*}:rollback"
body: "*"
};
}
// DeleteApiDeploymentRevision deletes a revision of a deployment.
rpc DeleteApiDeploymentRevision(DeleteApiDeploymentRevisionRequest) returns (ApiDeployment) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/apis/*/deployments/*}:deleteRevision"
};
option (google.api.method_signature) = "name";
}
// ListArtifacts returns matching artifacts.
rpc ListArtifacts(ListArtifactsRequest) returns (ListArtifactsResponse) {
option (google.api.http) = {
get: "/v1/{parent=projects/*/locations/*}/artifacts"
additional_bindings {
get: "/v1/{parent=projects/*/locations/*/apis/*}/artifacts"
}
additional_bindings {
get: "/v1/{parent=projects/*/locations/*/apis/*/versions/*}/artifacts"
}
additional_bindings {
get: "/v1/{parent=projects/*/locations/*/apis/*/versions/*/specs/*}/artifacts"
}
additional_bindings {
get: "/v1/{parent=projects/*/locations/*/apis/*/deployments/*}/artifacts"
}
};
option (google.api.method_signature) = "parent";
}
// GetArtifact returns a specified artifact.
rpc GetArtifact(GetArtifactRequest) returns (Artifact) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/artifacts/*}"
additional_bindings {
get: "/v1/{name=projects/*/locations/*/apis/*/artifacts/*}"
}
additional_bindings {
get: "/v1/{name=projects/*/locations/*/apis/*/versions/*/artifacts/*}"
}
additional_bindings {
get: "/v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*/artifacts/*}"
}
additional_bindings {
get: "/v1/{name=projects/*/locations/*/apis/*/deployments/*/artifacts/*}"
}
};
option (google.api.method_signature) = "name";
}
// GetArtifactContents returns the contents of a specified artifact.
// If artifacts are stored with GZip compression, the default behavior
// is to return the artifact uncompressed (the mime_type response field
// indicates the exact format returned).
rpc GetArtifactContents(GetArtifactContentsRequest) returns (google.api.HttpBody) {
option (google.api.http) = {
get: "/v1/{name=projects/*/locations/*/artifacts/*}:getContents"
additional_bindings {
get: "/v1/{name=projects/*/locations/*/apis/*/artifacts/*}:getContents"
}
additional_bindings {
get: "/v1/{name=projects/*/locations/*/apis/*/versions/*/artifacts/*}:getContents"
}
additional_bindings {
get: "/v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*/artifacts/*}:getContents"
}
additional_bindings {
get: "/v1/{name=projects/*/locations/*/apis/*/deployments/*/artifacts/*}:getContents"
}
};
option (google.api.method_signature) = "name";
}
// CreateArtifact creates a specified artifact.
rpc CreateArtifact(CreateArtifactRequest) returns (Artifact) {
option (google.api.http) = {
post: "/v1/{parent=projects/*/locations/*}/artifacts"
body: "artifact"
additional_bindings {
post: "/v1/{parent=projects/*/locations/*/apis/*}/artifacts"
body: "artifact"
}
additional_bindings {
post: "/v1/{parent=projects/*/locations/*/apis/*/versions/*}/artifacts"
body: "artifact"
}
additional_bindings {
post: "/v1/{parent=projects/*/locations/*/apis/*/versions/*/specs/*}/artifacts"
body: "artifact"
}
additional_bindings {
post: "/v1/{parent=projects/*/locations/*/apis/*/deployments/*}/artifacts"
body: "artifact"
}
};
option (google.api.method_signature) = "parent,artifact,artifact_id";
}
// ReplaceArtifact can be used to replace a specified artifact.
rpc ReplaceArtifact(ReplaceArtifactRequest) returns (Artifact) {
option (google.api.http) = {
put: "/v1/{artifact.name=projects/*/locations/*/artifacts/*}"
body: "artifact"
additional_bindings {
put: "/v1/{artifact.name=projects/*/locations/*/apis/*/artifacts/*}"
body: "artifact"
}
additional_bindings {
put: "/v1/{artifact.name=projects/*/locations/*/apis/*/versions/*/artifacts/*}"
body: "artifact"
}
additional_bindings {
put: "/v1/{artifact.name=projects/*/locations/*/apis/*/versions/*/specs/*/artifacts/*}"
body: "artifact"
}
additional_bindings {
put: "/v1/{artifact.name=projects/*/locations/*/apis/*/deployments/*/artifacts/*}"
body: "artifact"
}
};
option (google.api.method_signature) = "artifact";
}
// DeleteArtifact removes a specified artifact.
rpc DeleteArtifact(DeleteArtifactRequest) returns (google.protobuf.Empty) {
option (google.api.http) = {
delete: "/v1/{name=projects/*/locations/*/artifacts/*}"
additional_bindings {
delete: "/v1/{name=projects/*/locations/*/apis/*/artifacts/*}"
}
additional_bindings {
delete: "/v1/{name=projects/*/locations/*/apis/*/versions/*/artifacts/*}"
}
additional_bindings {
delete: "/v1/{name=projects/*/locations/*/apis/*/versions/*/specs/*/artifacts/*}"
}
additional_bindings {
delete: "/v1/{name=projects/*/locations/*/apis/*/deployments/*/artifacts/*}"
}
};
option (google.api.method_signature) = "name";
}
}
// Request message for ListApis.
message ListApisRequest {
// Required. The parent, which owns this collection of APIs.
// Format: projects/*/locations/*
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "apigeeregistry.googleapis.com/Api"
}
];
// The maximum number of APIs to return.
// The service may return fewer than this value.
// If unspecified, at most 50 values will be returned.
// The maximum is 1000; values above 1000 will be coerced to 1000.
int32 page_size = 2;
// A page token, received from a previous `ListApis` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListApis` must match
// the call that provided the page token.
string page_token = 3;
// An expression that can be used to filter the list. Filters use the Common
// Expression Language and can refer to all message fields.
string filter = 4;
// A comma-separated list of fields, e.g. "foo,bar"
// Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
string order_by = 5;
}
// Response message for ListApis.
message ListApisResponse {
// The APIs from the specified publisher.
repeated Api apis = 1;
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
string next_page_token = 2;
}
// Request message for GetApi.
message GetApiRequest {
// Required. The name of the API to retrieve.
// Format: projects/*/locations/*/apis/*
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "apigeeregistry.googleapis.com/Api"
}
];
}
// Request message for CreateApi.
message CreateApiRequest {
// Required. The parent, which owns this collection of APIs.
// Format: projects/*/locations/*
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "apigeeregistry.googleapis.com/Api"
}
];
// Required. The API to create.
Api api = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The ID to use for the api, which will become the final component of
// the api's resource name.
//
// This value should be 4-63 characters, and valid characters
// are /[a-z][0-9]-/.
//
// Following AIP-162, IDs must not have the form of a UUID.
string api_id = 3 [(google.api.field_behavior) = REQUIRED];
}
// Request message for UpdateApi.
message UpdateApiRequest {
// Required. The API to update.
//
// The `name` field is used to identify the API to update.
// Format: projects/*/locations/*/apis/*
Api api = 1 [(google.api.field_behavior) = REQUIRED];
// The list of fields to be updated. If omitted, all fields are updated that
// are set in the request message (fields set to default values are ignored).
// If a "*" is specified, all fields are updated, including fields that are
// unspecified/default in the request.
google.protobuf.FieldMask update_mask = 2;
// If set to true, and the api is not found, a new api_versions will be created.
// In this situation, `update_mask` is ignored.
bool allow_missing = 3;
}
// Request message for DeleteApi.
message DeleteApiRequest {
// Required. The name of the API to delete.
// Format: projects/*/locations/*/apis/*
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "apigeeregistry.googleapis.com/Api"
}
];
// If set to true, any child resources will also be deleted.
// (Otherwise, the request will only work if there are no child resources.)
bool force = 2;
}
// Request message for ListApiVersions.
message ListApiVersionsRequest {
// Required. The parent, which owns this collection of versions.
// Format: projects/*/locations/*/apis/*
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "apigeeregistry.googleapis.com/ApiVersion"
}
];
// The maximum number of versions to return.
// The service may return fewer than this value.
// If unspecified, at most 50 values will be returned.
// The maximum is 1000; values above 1000 will be coerced to 1000.
int32 page_size = 2;
// A page token, received from a previous `ListApiVersions` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListApiVersions` must
// match the call that provided the page token.
string page_token = 3;
// An expression that can be used to filter the list. Filters use the Common
// Expression Language and can refer to all message fields.
string filter = 4;
// A comma-separated list of fields, e.g. "foo,bar"
// Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
string order_by = 5;
}
// Response message for ListApiVersions.
message ListApiVersionsResponse {
// The versions from the specified publisher.
repeated ApiVersion api_versions = 1;
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
string next_page_token = 2;
}
// Request message for GetApiVersion.
message GetApiVersionRequest {
// Required. The name of the version to retrieve.
// Format: projects/*/locations/*/apis/*/versions/*
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "apigeeregistry.googleapis.com/ApiVersion"
}
];
}
// Request message for CreateApiVersion.
message CreateApiVersionRequest {
// Required. The parent, which owns this collection of versions.
// Format: projects/*/locations/*/apis/*
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "apigeeregistry.googleapis.com/ApiVersion"
}
];
// Required. The version to create.
ApiVersion api_version = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The ID to use for the version, which will become the final component of
// the version's resource name.
//
// This value should be 4-63 characters, and valid characters
// are /[a-z][0-9]-/.
//
// Following AIP-162, IDs must not have the form of a UUID.
string api_version_id = 3 [(google.api.field_behavior) = REQUIRED];
}
// Request message for UpdateApiVersion.
message UpdateApiVersionRequest {
// Required. The version to update.
//
// The `name` field is used to identify the version to update.
// Format: projects/*/locations/*/apis/*/versions/*
ApiVersion api_version = 1 [(google.api.field_behavior) = REQUIRED];
// The list of fields to be updated. If omitted, all fields are updated that
// are set in the request message (fields set to default values are ignored).
// If a "*" is specified, all fields are updated, including fields that are
// unspecified/default in the request.
google.protobuf.FieldMask update_mask = 2;
// If set to true, and the version is not found, a new version will be created.
// In this situation, `update_mask` is ignored.
bool allow_missing = 3;
}
// Request message for DeleteApiVersion.
message DeleteApiVersionRequest {
// Required. The name of the version to delete.
// Format: projects/*/locations/*/apis/*/versions/*
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "apigeeregistry.googleapis.com/ApiVersion"
}
];
// If set to true, any child resources will also be deleted.
// (Otherwise, the request will only work if there are no child resources.)
bool force = 2;
}
// Request message for ListApiSpecs.
message ListApiSpecsRequest {
// Required. The parent, which owns this collection of specs.
// Format: projects/*/locations/*/apis/*/versions/*
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "apigeeregistry.googleapis.com/ApiSpec"
}
];
// The maximum number of specs to return.
// The service may return fewer than this value.
// If unspecified, at most 50 values will be returned.
// The maximum is 1000; values above 1000 will be coerced to 1000.
int32 page_size = 2;
// A page token, received from a previous `ListApiSpecs` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListApiSpecs` must match
// the call that provided the page token.
string page_token = 3;
// An expression that can be used to filter the list. Filters use the Common
// Expression Language and can refer to all message fields except contents.
string filter = 4;
// A comma-separated list of fields, e.g. "foo,bar"
// Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
string order_by = 5;
}
// Response message for ListApiSpecs.
message ListApiSpecsResponse {
// The specs from the specified publisher.
repeated ApiSpec api_specs = 1;
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
string next_page_token = 2;
}
// Request message for GetApiSpec.
message GetApiSpecRequest {
// Required. The name of the spec to retrieve.
// Format: projects/*/locations/*/apis/*/versions/*/specs/*
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "apigeeregistry.googleapis.com/ApiSpec"
}
];
}
// Request message for GetApiSpecContents.
message GetApiSpecContentsRequest {
// Required. The name of the spec whose contents should be retrieved.
// Format: projects/*/locations/*/apis/*/versions/*/specs/*
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "apigeeregistry.googleapis.com/ApiSpec"
}
];
}
// Request message for CreateApiSpec.
message CreateApiSpecRequest {
// Required. The parent, which owns this collection of specs.
// Format: projects/*/locations/*/apis/*/versions/*
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "apigeeregistry.googleapis.com/ApiSpec"
}
];
// Required. The spec to create.
ApiSpec api_spec = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The ID to use for the spec, which will become the final component of
// the spec's resource name.
//
// This value should be 4-63 characters, and valid characters
// are /[a-z][0-9]-/.
//
// Following AIP-162, IDs must not have the form of a UUID.
string api_spec_id = 3 [(google.api.field_behavior) = REQUIRED];
}
// Request message for UpdateApiSpec.
message UpdateApiSpecRequest {
// Required. The spec to update.
//
// The `name` field is used to identify the spec to update.
// Format: projects/*/locations/*/apis/*/versions/*/specs/*
ApiSpec api_spec = 1 [(google.api.field_behavior) = REQUIRED];
// The list of fields to be updated. If omitted, all fields are updated that
// are set in the request message (fields set to default values are ignored).
// If a "*" is specified, all fields are updated, including fields that are
// unspecified/default in the request.
google.protobuf.FieldMask update_mask = 2;
// If set to true, and the spec is not found, a new spec will be created.
// In this situation, `update_mask` is ignored.
bool allow_missing = 3;
}
// Request message for DeleteApiSpec.
message DeleteApiSpecRequest {
// Required. The name of the spec to delete.
// Format: projects/*/locations/*/apis/*/versions/*/specs/*
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "apigeeregistry.googleapis.com/ApiSpec"
}
];
// If set to true, any child resources will also be deleted.
// (Otherwise, the request will only work if there are no child resources.)
bool force = 2;
}
// Request message for TagApiSpecRevision.
message TagApiSpecRevisionRequest {
// Required. The name of the spec to be tagged, including the revision ID.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "apigeeregistry.googleapis.com/ApiSpec"
}
];
// Required. The tag to apply.
// The tag should be at most 40 characters, and match `[a-z][a-z0-9-]{3,39}`.
string tag = 2 [(google.api.field_behavior) = REQUIRED];
}
// Request message for ListApiSpecRevisions.
message ListApiSpecRevisionsRequest {
// Required. The name of the spec to list revisions for.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "apigeeregistry.googleapis.com/ApiSpec"
}
];
// The maximum number of revisions to return per page.
int32 page_size = 2;
// The page token, received from a previous ListApiSpecRevisions call.
// Provide this to retrieve the subsequent page.
string page_token = 3;
// An expression that can be used to filter the list. Filters use the Common
// Expression Language and can refer to all message fields.
string filter = 4;
}
// Response message for ListApiSpecRevisionsResponse.
message ListApiSpecRevisionsResponse {
// The revisions of the spec.
repeated ApiSpec api_specs = 1;
// A token that can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
string next_page_token = 2;
}
// Request message for RollbackApiSpec.
message RollbackApiSpecRequest {
// Required. The spec being rolled back.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "apigeeregistry.googleapis.com/ApiSpec"
}
];
// Required. The revision ID to roll back to.
// It must be a revision of the same spec.
//
// Example: c7cfa2a8
string revision_id = 2 [(google.api.field_behavior) = REQUIRED];
}
// Request message for DeleteApiSpecRevision.
message DeleteApiSpecRevisionRequest {
// Required. The name of the spec revision to be deleted,
// with a revision ID explicitly included.
//
// Example:
// projects/sample/locations/global/apis/petstore/versions/1.0.0/specs/openapi@c7cfa2a8
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "apigeeregistry.googleapis.com/ApiSpec"
}
];
}
// Request message for ListApiDeployments.
message ListApiDeploymentsRequest {
// Required. The parent, which owns this collection of deployments.
// Format: projects/*/locations/*/apis/*
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "apigeeregistry.googleapis.com/ApiDeployment"
}
];
// The maximum number of deployments to return.
// The service may return fewer than this value.
// If unspecified, at most 50 values will be returned.
// The maximum is 1000; values above 1000 will be coerced to 1000.
int32 page_size = 2;
// A page token, received from a previous `ListApiDeployments` call.
// Provide this to retrieve the subsequent page.
//
// When paginating, all other parameters provided to `ListApiDeployments` must
// match the call that provided the page token.
string page_token = 3;
// An expression that can be used to filter the list. Filters use the Common
// Expression Language and can refer to all message fields.
string filter = 4;
// A comma-separated list of fields, e.g. "foo,bar"
// Fields can be sorted in descending order using the "desc" identifier, e.g. "foo desc,bar"
string order_by = 5;
}
// Response message for ListApiDeployments.
message ListApiDeploymentsResponse {
// The deployments from the specified publisher.
repeated ApiDeployment api_deployments = 1;
// A token, which can be sent as `page_token` to retrieve the next page.
// If this field is omitted, there are no subsequent pages.
string next_page_token = 2;
}
// Request message for GetApiDeployment.
message GetApiDeploymentRequest {
// Required. The name of the deployment to retrieve.
// Format: projects/*/locations/*/apis/*/deployments/*
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "apigeeregistry.googleapis.com/ApiDeployment"
}
];
}
// Request message for CreateApiDeployment.
message CreateApiDeploymentRequest {
// Required. The parent, which owns this collection of deployments.
// Format: projects/*/locations/*/apis/*
string parent = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
child_type: "apigeeregistry.googleapis.com/ApiDeployment"
}
];
// Required. The deployment to create.
ApiDeployment api_deployment = 2 [(google.api.field_behavior) = REQUIRED];
// Required. The ID to use for the deployment, which will become the final component of
// the deployment's resource name.
//
// This value should be 4-63 characters, and valid characters
// are /[a-z][0-9]-/.
//
// Following AIP-162, IDs must not have the form of a UUID.
string api_deployment_id = 3 [(google.api.field_behavior) = REQUIRED];
}
// Request message for UpdateApiDeployment.
message UpdateApiDeploymentRequest {
// Required. The deployment to update.
//
// The `name` field is used to identify the deployment to update.
// Format: projects/*/locations/*/apis/*/deployments/*
ApiDeployment api_deployment = 1 [(google.api.field_behavior) = REQUIRED];
// The list of fields to be updated. If omitted, all fields are updated that
// are set in the request message (fields set to default values are ignored).
// If a "*" is specified, all fields are updated, including fields that are
// unspecified/default in the request.
google.protobuf.FieldMask update_mask = 2;
// If set to true, and the deployment is not found, a new deployment will be created.
// In this situation, `update_mask` is ignored.
bool allow_missing = 3;
}
// Request message for DeleteApiDeployment.
message DeleteApiDeploymentRequest {
// Required. The name of the deployment to delete.
// Format: projects/*/locations/*/apis/*/deployments/*
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "apigeeregistry.googleapis.com/ApiDeployment"
}
];
// If set to true, any child resources will also be deleted.
// (Otherwise, the request will only work if there are no child resources.)
bool force = 2;
}
// Request message for TagApiDeploymentRevision.
message TagApiDeploymentRevisionRequest {
// Required. The name of the deployment to be tagged, including the revision ID.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "apigeeregistry.googleapis.com/ApiDeployment"
}
];
// Required. The tag to apply.
// The tag should be at most 40 characters, and match `[a-z][a-z0-9-]{3,39}`.
string tag = 2 [(google.api.field_behavior) = REQUIRED];
}
// Request message for ListApiDeploymentRevisions.
message ListApiDeploymentRevisionsRequest {
// Required. The name of the deployment to list revisions for.
string name = 1 [
(google.api.field_behavior) = REQUIRED,
(google.api.resource_reference) = {
type: "apigeeregistry.googleapis.com/ApiDeployment"
}
];
// The maximum number of revisions to return per page.
int32 page_size = 2;
// The page token, received from a previous ListApiDeploymentRevisions call.
// Provide this to retrieve the subsequent page.
string page_token = 3;
// An expression that can be used to filter the list. Filters use the Common