-
Notifications
You must be signed in to change notification settings - Fork 55
/
doc_pb.ts
1657 lines (1391 loc) · 58.2 KB
/
doc_pb.ts
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-2024 Buf Technologies, Inc.
//
// 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.
// @generated by protoc-gen-es v1.8.0 with parameter "ts_nocheck=false,target=ts"
// @generated from file buf/alpha/registry/v1alpha1/doc.proto (package buf.alpha.registry.v1alpha1, syntax proto3)
/* eslint-disable */
import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
import { Message as Message$1, proto3 } from "@bufbuild/protobuf";
/**
* GetSourceDirectoryInfoRequest takes an owner, repository, and reference.
*
* @generated from message buf.alpha.registry.v1alpha1.GetSourceDirectoryInfoRequest
*/
export class GetSourceDirectoryInfoRequest extends Message$1<GetSourceDirectoryInfoRequest> {
/**
* @generated from field: string owner = 1;
*/
owner = "";
/**
* @generated from field: string repository = 2;
*/
repository = "";
/**
* @generated from field: string reference = 3;
*/
reference = "";
constructor(data?: PartialMessage<GetSourceDirectoryInfoRequest>) {
super();
proto3.util.initPartial(data, this);
}
static readonly runtime: typeof proto3 = proto3;
static readonly typeName = "buf.alpha.registry.v1alpha1.GetSourceDirectoryInfoRequest";
static readonly fields: FieldList = proto3.util.newFieldList(() => [
{ no: 1, name: "owner", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 2, name: "repository", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 3, name: "reference", kind: "scalar", T: 9 /* ScalarType.STRING */ },
]);
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetSourceDirectoryInfoRequest {
return new GetSourceDirectoryInfoRequest().fromBinary(bytes, options);
}
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GetSourceDirectoryInfoRequest {
return new GetSourceDirectoryInfoRequest().fromJson(jsonValue, options);
}
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetSourceDirectoryInfoRequest {
return new GetSourceDirectoryInfoRequest().fromJsonString(jsonString, options);
}
static equals(a: GetSourceDirectoryInfoRequest | PlainMessage<GetSourceDirectoryInfoRequest> | undefined, b: GetSourceDirectoryInfoRequest | PlainMessage<GetSourceDirectoryInfoRequest> | undefined): boolean {
return proto3.util.equals(GetSourceDirectoryInfoRequest, a, b);
}
}
/**
* GetSourceDirectoryInfoResponse returns the root FileInfo for the requested module.
*
* @generated from message buf.alpha.registry.v1alpha1.GetSourceDirectoryInfoResponse
*/
export class GetSourceDirectoryInfoResponse extends Message$1<GetSourceDirectoryInfoResponse> {
/**
* @generated from field: buf.alpha.registry.v1alpha1.FileInfo root = 1;
*/
root?: FileInfo;
constructor(data?: PartialMessage<GetSourceDirectoryInfoResponse>) {
super();
proto3.util.initPartial(data, this);
}
static readonly runtime: typeof proto3 = proto3;
static readonly typeName = "buf.alpha.registry.v1alpha1.GetSourceDirectoryInfoResponse";
static readonly fields: FieldList = proto3.util.newFieldList(() => [
{ no: 1, name: "root", kind: "message", T: FileInfo },
]);
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetSourceDirectoryInfoResponse {
return new GetSourceDirectoryInfoResponse().fromBinary(bytes, options);
}
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GetSourceDirectoryInfoResponse {
return new GetSourceDirectoryInfoResponse().fromJson(jsonValue, options);
}
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetSourceDirectoryInfoResponse {
return new GetSourceDirectoryInfoResponse().fromJsonString(jsonString, options);
}
static equals(a: GetSourceDirectoryInfoResponse | PlainMessage<GetSourceDirectoryInfoResponse> | undefined, b: GetSourceDirectoryInfoResponse | PlainMessage<GetSourceDirectoryInfoResponse> | undefined): boolean {
return proto3.util.equals(GetSourceDirectoryInfoResponse, a, b);
}
}
/**
* FileInfo is a nested structure that contains the file path, whether or not it's a directory,
* and if so, the FileInfo children of that directory.
*
* @generated from message buf.alpha.registry.v1alpha1.FileInfo
*/
export class FileInfo extends Message$1<FileInfo> {
/**
* the normalized path of the directory, relative to the root of the module.
*
* @generated from field: string path = 1;
*/
path = "";
/**
* @generated from field: bool is_dir = 2;
*/
isDir = false;
/**
* @generated from field: repeated buf.alpha.registry.v1alpha1.FileInfo children = 3;
*/
children: FileInfo[] = [];
constructor(data?: PartialMessage<FileInfo>) {
super();
proto3.util.initPartial(data, this);
}
static readonly runtime: typeof proto3 = proto3;
static readonly typeName = "buf.alpha.registry.v1alpha1.FileInfo";
static readonly fields: FieldList = proto3.util.newFieldList(() => [
{ no: 1, name: "path", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 2, name: "is_dir", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
{ no: 3, name: "children", kind: "message", T: FileInfo, repeated: true },
]);
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): FileInfo {
return new FileInfo().fromBinary(bytes, options);
}
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): FileInfo {
return new FileInfo().fromJson(jsonValue, options);
}
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): FileInfo {
return new FileInfo().fromJsonString(jsonString, options);
}
static equals(a: FileInfo | PlainMessage<FileInfo> | undefined, b: FileInfo | PlainMessage<FileInfo> | undefined): boolean {
return proto3.util.equals(FileInfo, a, b);
}
}
/**
* GetSourceFileRequest takes an owner, repository, reference, and normalized path.
*
* @generated from message buf.alpha.registry.v1alpha1.GetSourceFileRequest
*/
export class GetSourceFileRequest extends Message$1<GetSourceFileRequest> {
/**
* @generated from field: string owner = 1;
*/
owner = "";
/**
* @generated from field: string repository = 2;
*/
repository = "";
/**
* @generated from field: string reference = 3;
*/
reference = "";
/**
* the normalized path to the requested file, relative to the root of the module.
*
* @generated from field: string path = 4;
*/
path = "";
constructor(data?: PartialMessage<GetSourceFileRequest>) {
super();
proto3.util.initPartial(data, this);
}
static readonly runtime: typeof proto3 = proto3;
static readonly typeName = "buf.alpha.registry.v1alpha1.GetSourceFileRequest";
static readonly fields: FieldList = proto3.util.newFieldList(() => [
{ no: 1, name: "owner", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 2, name: "repository", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 3, name: "reference", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 4, name: "path", kind: "scalar", T: 9 /* ScalarType.STRING */ },
]);
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetSourceFileRequest {
return new GetSourceFileRequest().fromBinary(bytes, options);
}
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GetSourceFileRequest {
return new GetSourceFileRequest().fromJson(jsonValue, options);
}
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetSourceFileRequest {
return new GetSourceFileRequest().fromJsonString(jsonString, options);
}
static equals(a: GetSourceFileRequest | PlainMessage<GetSourceFileRequest> | undefined, b: GetSourceFileRequest | PlainMessage<GetSourceFileRequest> | undefined): boolean {
return proto3.util.equals(GetSourceFileRequest, a, b);
}
}
/**
* GetSourceFileResponse returns the source code contents of the requested file.
*
* @generated from message buf.alpha.registry.v1alpha1.GetSourceFileResponse
*/
export class GetSourceFileResponse extends Message$1<GetSourceFileResponse> {
/**
* content is the content of the file.
*
* @generated from field: bytes content = 1;
*/
content = new Uint8Array(0);
constructor(data?: PartialMessage<GetSourceFileResponse>) {
super();
proto3.util.initPartial(data, this);
}
static readonly runtime: typeof proto3 = proto3;
static readonly typeName = "buf.alpha.registry.v1alpha1.GetSourceFileResponse";
static readonly fields: FieldList = proto3.util.newFieldList(() => [
{ no: 1, name: "content", kind: "scalar", T: 12 /* ScalarType.BYTES */ },
]);
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetSourceFileResponse {
return new GetSourceFileResponse().fromBinary(bytes, options);
}
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GetSourceFileResponse {
return new GetSourceFileResponse().fromJson(jsonValue, options);
}
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetSourceFileResponse {
return new GetSourceFileResponse().fromJsonString(jsonString, options);
}
static equals(a: GetSourceFileResponse | PlainMessage<GetSourceFileResponse> | undefined, b: GetSourceFileResponse | PlainMessage<GetSourceFileResponse> | undefined): boolean {
return proto3.util.equals(GetSourceFileResponse, a, b);
}
}
/**
* GetModulePackagesRequest takes an owner, repository, and reference.
*
* @generated from message buf.alpha.registry.v1alpha1.GetModulePackagesRequest
*/
export class GetModulePackagesRequest extends Message$1<GetModulePackagesRequest> {
/**
* @generated from field: string owner = 1;
*/
owner = "";
/**
* @generated from field: string repository = 2;
*/
repository = "";
/**
* @generated from field: string reference = 3;
*/
reference = "";
constructor(data?: PartialMessage<GetModulePackagesRequest>) {
super();
proto3.util.initPartial(data, this);
}
static readonly runtime: typeof proto3 = proto3;
static readonly typeName = "buf.alpha.registry.v1alpha1.GetModulePackagesRequest";
static readonly fields: FieldList = proto3.util.newFieldList(() => [
{ no: 1, name: "owner", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 2, name: "repository", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 3, name: "reference", kind: "scalar", T: 9 /* ScalarType.STRING */ },
]);
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetModulePackagesRequest {
return new GetModulePackagesRequest().fromBinary(bytes, options);
}
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GetModulePackagesRequest {
return new GetModulePackagesRequest().fromJson(jsonValue, options);
}
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetModulePackagesRequest {
return new GetModulePackagesRequest().fromJsonString(jsonString, options);
}
static equals(a: GetModulePackagesRequest | PlainMessage<GetModulePackagesRequest> | undefined, b: GetModulePackagesRequest | PlainMessage<GetModulePackagesRequest> | undefined): boolean {
return proto3.util.equals(GetModulePackagesRequest, a, b);
}
}
/**
* GetModulePackagesResponse returns the list of ModulePackages for the requested module.
*
* @generated from message buf.alpha.registry.v1alpha1.GetModulePackagesResponse
*/
export class GetModulePackagesResponse extends Message$1<GetModulePackagesResponse> {
/**
* @generated from field: string name = 1;
*/
name = "";
/**
* @generated from field: repeated buf.alpha.registry.v1alpha1.ModulePackage module_packages = 2;
*/
modulePackages: ModulePackage[] = [];
constructor(data?: PartialMessage<GetModulePackagesResponse>) {
super();
proto3.util.initPartial(data, this);
}
static readonly runtime: typeof proto3 = proto3;
static readonly typeName = "buf.alpha.registry.v1alpha1.GetModulePackagesResponse";
static readonly fields: FieldList = proto3.util.newFieldList(() => [
{ no: 1, name: "name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 2, name: "module_packages", kind: "message", T: ModulePackage, repeated: true },
]);
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetModulePackagesResponse {
return new GetModulePackagesResponse().fromBinary(bytes, options);
}
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GetModulePackagesResponse {
return new GetModulePackagesResponse().fromJson(jsonValue, options);
}
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetModulePackagesResponse {
return new GetModulePackagesResponse().fromJsonString(jsonString, options);
}
static equals(a: GetModulePackagesResponse | PlainMessage<GetModulePackagesResponse> | undefined, b: GetModulePackagesResponse | PlainMessage<GetModulePackagesResponse> | undefined): boolean {
return proto3.util.equals(GetModulePackagesResponse, a, b);
}
}
/**
* ModulePackage provides the details about a module's associated package.
*
* @generated from message buf.alpha.registry.v1alpha1.ModulePackage
*/
export class ModulePackage extends Message$1<ModulePackage> {
/**
* @generated from field: string name = 1;
*/
name = "";
/**
* @generated from field: string description = 2;
*/
description = "";
constructor(data?: PartialMessage<ModulePackage>) {
super();
proto3.util.initPartial(data, this);
}
static readonly runtime: typeof proto3 = proto3;
static readonly typeName = "buf.alpha.registry.v1alpha1.ModulePackage";
static readonly fields: FieldList = proto3.util.newFieldList(() => [
{ no: 1, name: "name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 2, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ },
]);
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ModulePackage {
return new ModulePackage().fromBinary(bytes, options);
}
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): ModulePackage {
return new ModulePackage().fromJson(jsonValue, options);
}
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): ModulePackage {
return new ModulePackage().fromJsonString(jsonString, options);
}
static equals(a: ModulePackage | PlainMessage<ModulePackage> | undefined, b: ModulePackage | PlainMessage<ModulePackage> | undefined): boolean {
return proto3.util.equals(ModulePackage, a, b);
}
}
/**
* GetModuleDocumentationRequest takes an owner, repository, and reference.
*
* @generated from message buf.alpha.registry.v1alpha1.GetModuleDocumentationRequest
*/
export class GetModuleDocumentationRequest extends Message$1<GetModuleDocumentationRequest> {
/**
* @generated from field: string owner = 1;
*/
owner = "";
/**
* @generated from field: string repository = 2;
*/
repository = "";
/**
* @generated from field: string reference = 3;
*/
reference = "";
constructor(data?: PartialMessage<GetModuleDocumentationRequest>) {
super();
proto3.util.initPartial(data, this);
}
static readonly runtime: typeof proto3 = proto3;
static readonly typeName = "buf.alpha.registry.v1alpha1.GetModuleDocumentationRequest";
static readonly fields: FieldList = proto3.util.newFieldList(() => [
{ no: 1, name: "owner", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 2, name: "repository", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 3, name: "reference", kind: "scalar", T: 9 /* ScalarType.STRING */ },
]);
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetModuleDocumentationRequest {
return new GetModuleDocumentationRequest().fromBinary(bytes, options);
}
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GetModuleDocumentationRequest {
return new GetModuleDocumentationRequest().fromJson(jsonValue, options);
}
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetModuleDocumentationRequest {
return new GetModuleDocumentationRequest().fromJsonString(jsonString, options);
}
static equals(a: GetModuleDocumentationRequest | PlainMessage<GetModuleDocumentationRequest> | undefined, b: GetModuleDocumentationRequest | PlainMessage<GetModuleDocumentationRequest> | undefined): boolean {
return proto3.util.equals(GetModuleDocumentationRequest, a, b);
}
}
/**
* GetModuleDocumentationResponse returns the ModuleDocumentation for the requested module.
*
* @generated from message buf.alpha.registry.v1alpha1.GetModuleDocumentationResponse
*/
export class GetModuleDocumentationResponse extends Message$1<GetModuleDocumentationResponse> {
/**
* @generated from field: buf.alpha.registry.v1alpha1.ModuleDocumentation module_documentation = 1;
*/
moduleDocumentation?: ModuleDocumentation;
constructor(data?: PartialMessage<GetModuleDocumentationResponse>) {
super();
proto3.util.initPartial(data, this);
}
static readonly runtime: typeof proto3 = proto3;
static readonly typeName = "buf.alpha.registry.v1alpha1.GetModuleDocumentationResponse";
static readonly fields: FieldList = proto3.util.newFieldList(() => [
{ no: 1, name: "module_documentation", kind: "message", T: ModuleDocumentation },
]);
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetModuleDocumentationResponse {
return new GetModuleDocumentationResponse().fromBinary(bytes, options);
}
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GetModuleDocumentationResponse {
return new GetModuleDocumentationResponse().fromJson(jsonValue, options);
}
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetModuleDocumentationResponse {
return new GetModuleDocumentationResponse().fromJsonString(jsonString, options);
}
static equals(a: GetModuleDocumentationResponse | PlainMessage<GetModuleDocumentationResponse> | undefined, b: GetModuleDocumentationResponse | PlainMessage<GetModuleDocumentationResponse> | undefined): boolean {
return proto3.util.equals(GetModuleDocumentationResponse, a, b);
}
}
/**
* ModuleDocumentation provides the name of the module and associated documentation.
*
* @generated from message buf.alpha.registry.v1alpha1.ModuleDocumentation
*/
export class ModuleDocumentation extends Message$1<ModuleDocumentation> {
/**
* @generated from field: string name = 1;
*/
name = "";
/**
* This is the string representation of the contents of the buf.md file for module-level documentation.
*
* The buf.md file is a part of the module.
* string is used to enforce UTF-8 encoding or 7-bit ASCII text.
*
* @generated from field: string documentation = 3;
*/
documentation = "";
constructor(data?: PartialMessage<ModuleDocumentation>) {
super();
proto3.util.initPartial(data, this);
}
static readonly runtime: typeof proto3 = proto3;
static readonly typeName = "buf.alpha.registry.v1alpha1.ModuleDocumentation";
static readonly fields: FieldList = proto3.util.newFieldList(() => [
{ no: 1, name: "name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 3, name: "documentation", kind: "scalar", T: 9 /* ScalarType.STRING */ },
]);
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): ModuleDocumentation {
return new ModuleDocumentation().fromBinary(bytes, options);
}
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): ModuleDocumentation {
return new ModuleDocumentation().fromJson(jsonValue, options);
}
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): ModuleDocumentation {
return new ModuleDocumentation().fromJsonString(jsonString, options);
}
static equals(a: ModuleDocumentation | PlainMessage<ModuleDocumentation> | undefined, b: ModuleDocumentation | PlainMessage<ModuleDocumentation> | undefined): boolean {
return proto3.util.equals(ModuleDocumentation, a, b);
}
}
/**
* GetPackageDocumentationRequest takes an owner, repository, reference, and package name.
*
* @generated from message buf.alpha.registry.v1alpha1.GetPackageDocumentationRequest
*/
export class GetPackageDocumentationRequest extends Message$1<GetPackageDocumentationRequest> {
/**
* @generated from field: string owner = 1;
*/
owner = "";
/**
* @generated from field: string repository = 2;
*/
repository = "";
/**
* @generated from field: string reference = 3;
*/
reference = "";
/**
* this is the fully qualified package name.
*
* @generated from field: string package_name = 4;
*/
packageName = "";
constructor(data?: PartialMessage<GetPackageDocumentationRequest>) {
super();
proto3.util.initPartial(data, this);
}
static readonly runtime: typeof proto3 = proto3;
static readonly typeName = "buf.alpha.registry.v1alpha1.GetPackageDocumentationRequest";
static readonly fields: FieldList = proto3.util.newFieldList(() => [
{ no: 1, name: "owner", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 2, name: "repository", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 3, name: "reference", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 4, name: "package_name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
]);
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetPackageDocumentationRequest {
return new GetPackageDocumentationRequest().fromBinary(bytes, options);
}
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GetPackageDocumentationRequest {
return new GetPackageDocumentationRequest().fromJson(jsonValue, options);
}
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetPackageDocumentationRequest {
return new GetPackageDocumentationRequest().fromJsonString(jsonString, options);
}
static equals(a: GetPackageDocumentationRequest | PlainMessage<GetPackageDocumentationRequest> | undefined, b: GetPackageDocumentationRequest | PlainMessage<GetPackageDocumentationRequest> | undefined): boolean {
return proto3.util.equals(GetPackageDocumentationRequest, a, b);
}
}
/**
* GetPackageDocumentationReponse returns the documentation for the requested package.
*
* @generated from message buf.alpha.registry.v1alpha1.GetPackageDocumentationResponse
*/
export class GetPackageDocumentationResponse extends Message$1<GetPackageDocumentationResponse> {
/**
* @generated from field: buf.alpha.registry.v1alpha1.PackageDocumentation package_documentation = 1;
*/
packageDocumentation?: PackageDocumentation;
constructor(data?: PartialMessage<GetPackageDocumentationResponse>) {
super();
proto3.util.initPartial(data, this);
}
static readonly runtime: typeof proto3 = proto3;
static readonly typeName = "buf.alpha.registry.v1alpha1.GetPackageDocumentationResponse";
static readonly fields: FieldList = proto3.util.newFieldList(() => [
{ no: 1, name: "package_documentation", kind: "message", T: PackageDocumentation },
]);
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetPackageDocumentationResponse {
return new GetPackageDocumentationResponse().fromBinary(bytes, options);
}
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GetPackageDocumentationResponse {
return new GetPackageDocumentationResponse().fromJson(jsonValue, options);
}
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetPackageDocumentationResponse {
return new GetPackageDocumentationResponse().fromJsonString(jsonString, options);
}
static equals(a: GetPackageDocumentationResponse | PlainMessage<GetPackageDocumentationResponse> | undefined, b: GetPackageDocumentationResponse | PlainMessage<GetPackageDocumentationResponse> | undefined): boolean {
return proto3.util.equals(GetPackageDocumentationResponse, a, b);
}
}
/**
* PackageDocumentation provides the name, description, and top level types defined in the package.
*
* @generated from message buf.alpha.registry.v1alpha1.PackageDocumentation
*/
export class PackageDocumentation extends Message$1<PackageDocumentation> {
/**
* @generated from field: string name = 1;
*/
name = "";
/**
* description contains the package-level comment documentation.
* There is currently no convention for this.
*
* This is derived from the leading comments at the top level of the package.
* Paragraph newlines (double new lines) are respected, however single newlines are not.
* Note that any leading and trailing `//` or spaces within a `/* *\/` block will be stripped.
*
* @generated from field: string description = 2;
*/
description = "";
/**
* services contains all the services defined in the package in alphabetical order.
*
* @generated from field: repeated buf.alpha.registry.v1alpha1.Service services = 3;
*/
services: Service[] = [];
/**
* enums contains all the enums defined in the package in alphabetical order.
*
* @generated from field: repeated buf.alpha.registry.v1alpha1.Enum enums = 4;
*/
enums: Enum[] = [];
/**
* messages contains all the messages defined in the package in alphabetical order.
*
* @generated from field: repeated buf.alpha.registry.v1alpha1.Message messages = 5;
*/
messages: Message[] = [];
/**
* extensions contains all the file level extensions in the package in alphabetical order.
*
* @generated from field: repeated buf.alpha.registry.v1alpha1.FileExtension file_extensions = 6;
*/
fileExtensions: FileExtension[] = [];
constructor(data?: PartialMessage<PackageDocumentation>) {
super();
proto3.util.initPartial(data, this);
}
static readonly runtime: typeof proto3 = proto3;
static readonly typeName = "buf.alpha.registry.v1alpha1.PackageDocumentation";
static readonly fields: FieldList = proto3.util.newFieldList(() => [
{ no: 1, name: "name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 2, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 3, name: "services", kind: "message", T: Service, repeated: true },
{ no: 4, name: "enums", kind: "message", T: Enum, repeated: true },
{ no: 5, name: "messages", kind: "message", T: Message, repeated: true },
{ no: 6, name: "file_extensions", kind: "message", T: FileExtension, repeated: true },
]);
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PackageDocumentation {
return new PackageDocumentation().fromBinary(bytes, options);
}
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PackageDocumentation {
return new PackageDocumentation().fromJson(jsonValue, options);
}
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PackageDocumentation {
return new PackageDocumentation().fromJsonString(jsonString, options);
}
static equals(a: PackageDocumentation | PlainMessage<PackageDocumentation> | undefined, b: PackageDocumentation | PlainMessage<PackageDocumentation> | undefined): boolean {
return proto3.util.equals(PackageDocumentation, a, b);
}
}
/**
* Location provides the location information for the source code.
*
* This does not provide the leading or trailing comments as these will
* be parsed into descriptions or dropped respectively.
*
* @generated from message buf.alpha.registry.v1alpha1.Location
*/
export class Location extends Message$1<Location> {
/**
* @generated from field: int32 start_line = 1;
*/
startLine = 0;
/**
* @generated from field: int32 start_column = 2;
*/
startColumn = 0;
/**
* @generated from field: int32 end_line = 3;
*/
endLine = 0;
/**
* @generated from field: int32 end_column = 4;
*/
endColumn = 0;
constructor(data?: PartialMessage<Location>) {
super();
proto3.util.initPartial(data, this);
}
static readonly runtime: typeof proto3 = proto3;
static readonly typeName = "buf.alpha.registry.v1alpha1.Location";
static readonly fields: FieldList = proto3.util.newFieldList(() => [
{ no: 1, name: "start_line", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
{ no: 2, name: "start_column", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
{ no: 3, name: "end_line", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
{ no: 4, name: "end_column", kind: "scalar", T: 5 /* ScalarType.INT32 */ },
]);
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Location {
return new Location().fromBinary(bytes, options);
}
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Location {
return new Location().fromJson(jsonValue, options);
}
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Location {
return new Location().fromJsonString(jsonString, options);
}
static equals(a: Location | PlainMessage<Location> | undefined, b: Location | PlainMessage<Location> | undefined): boolean {
return proto3.util.equals(Location, a, b);
}
}
/**
* Service provides information for the documentation for a given service type in a file.
*
* @generated from message buf.alpha.registry.v1alpha1.Service
*/
export class Service extends Message$1<Service> {
/**
* @generated from field: string name = 1;
*/
name = "";
/**
* nested_name includes the nested types for a given type definition.
*
* @generated from field: string nested_name = 2;
*/
nestedName = "";
/**
* full_name includes the package name and nested types for a given type definition.
*
* @generated from field: string full_name = 3;
*/
fullName = "";
/**
* description is derived from the leading comments of a given service.
*
* Paragraph newlines (double new lines) are respected, however single newlines are not.
* Note that any leading and trailing `//` or spaces within a `/* *\/` block will be stripped.
*
* @generated from field: string description = 4;
*/
description = "";
/**
* file_path is the normalized path of the file containing the service.
* This is used for navigating to the source code for the service.
*
* @generated from field: string file_path = 5;
*/
filePath = "";
/**
* @generated from field: buf.alpha.registry.v1alpha1.Location location = 6;
*/
location?: Location;
/**
* @generated from field: repeated buf.alpha.registry.v1alpha1.Method methods = 7;
*/
methods: Method[] = [];
constructor(data?: PartialMessage<Service>) {
super();
proto3.util.initPartial(data, this);
}
static readonly runtime: typeof proto3 = proto3;
static readonly typeName = "buf.alpha.registry.v1alpha1.Service";
static readonly fields: FieldList = proto3.util.newFieldList(() => [
{ no: 1, name: "name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 2, name: "nested_name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 3, name: "full_name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 4, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 5, name: "file_path", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 6, name: "location", kind: "message", T: Location },
{ no: 7, name: "methods", kind: "message", T: Method, repeated: true },
]);
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Service {
return new Service().fromBinary(bytes, options);
}
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Service {
return new Service().fromJson(jsonValue, options);
}
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Service {
return new Service().fromJsonString(jsonString, options);
}
static equals(a: Service | PlainMessage<Service> | undefined, b: Service | PlainMessage<Service> | undefined): boolean {
return proto3.util.equals(Service, a, b);
}
}
/**
* Method provides information for the documentation for a method of a given service.
*
* @generated from message buf.alpha.registry.v1alpha1.Method
*/
export class Method extends Message$1<Method> {
/**
* @generated from field: string name = 1;
*/
name = "";
/**
* description is derived from the leading comments of a given method.
*
* Paragraph newlines (double new lines) are respected, however single newlines are not.
* Note that any leading and trailing `//` or spaces within a `/* *\/` block will be stripped.
*
* @generated from field: string description = 2;
*/
description = "";
/**
* @generated from field: buf.alpha.registry.v1alpha1.MethodRequestResponse request = 3;
*/
request?: MethodRequestResponse;
/**
* @generated from field: buf.alpha.registry.v1alpha1.MethodRequestResponse response = 4;
*/
response?: MethodRequestResponse;
constructor(data?: PartialMessage<Method>) {
super();
proto3.util.initPartial(data, this);
}
static readonly runtime: typeof proto3 = proto3;
static readonly typeName = "buf.alpha.registry.v1alpha1.Method";
static readonly fields: FieldList = proto3.util.newFieldList(() => [
{ no: 1, name: "name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 2, name: "description", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 3, name: "request", kind: "message", T: MethodRequestResponse },
{ no: 4, name: "response", kind: "message", T: MethodRequestResponse },
]);
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Method {
return new Method().fromBinary(bytes, options);
}
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Method {
return new Method().fromJson(jsonValue, options);
}
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Method {
return new Method().fromJsonString(jsonString, options);
}
static equals(a: Method | PlainMessage<Method> | undefined, b: Method | PlainMessage<Method> | undefined): boolean {
return proto3.util.equals(Method, a, b);
}
}
/**
* MethodRequestResponse provides information for the documentation of a Method request or response message.
*
* @generated from message buf.alpha.registry.v1alpha1.MethodRequestResponse
*/
export class MethodRequestResponse extends Message$1<MethodRequestResponse> {
/**
* nested_type is the nested name of the message of the request or response. This includes nested definitions.
*
* @generated from field: string nested_type = 1;
*/
nestedType = "";
/**
* full_type is the fully qualified name of the message of the request or response. This includes package and nested definitions.
*
* @generated from field: string full_type = 2;
*/
fullType = "";
/**
* boolean flag for whether the streaming label is set on an method request or response.
*
* @generated from field: bool streaming = 3;
*/
streaming = false;
/**
* @generated from field: buf.alpha.registry.v1alpha1.Message message = 4;
*/
message?: Message;
/**
* import_module_ref is included if the request or response is an imported type.
* It contains all the metadata for the import.
*
* @generated from field: buf.alpha.registry.v1alpha1.ImportModuleRef import_module_ref = 5;
*/
importModuleRef?: ImportModuleRef;
constructor(data?: PartialMessage<MethodRequestResponse>) {
super();
proto3.util.initPartial(data, this);
}
static readonly runtime: typeof proto3 = proto3;
static readonly typeName = "buf.alpha.registry.v1alpha1.MethodRequestResponse";
static readonly fields: FieldList = proto3.util.newFieldList(() => [
{ no: 1, name: "nested_type", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 2, name: "full_type", kind: "scalar", T: 9 /* ScalarType.STRING */ },
{ no: 3, name: "streaming", kind: "scalar", T: 8 /* ScalarType.BOOL */ },
{ no: 4, name: "message", kind: "message", T: Message },
{ no: 5, name: "import_module_ref", kind: "message", T: ImportModuleRef },
]);
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): MethodRequestResponse {
return new MethodRequestResponse().fromBinary(bytes, options);
}
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): MethodRequestResponse {
return new MethodRequestResponse().fromJson(jsonValue, options);
}