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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="apihub_v1.html">API hub API</a> . <a href="apihub_v1.projects.html">projects</a> . <a href="apihub_v1.projects.locations.html">locations</a> . <a href="apihub_v1.projects.locations.apis.html">apis</a> . <a href="apihub_v1.projects.locations.apis.versions.html">versions</a> . <a href="apihub_v1.projects.locations.apis.versions.specs.html">specs</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, specId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Add a spec to an API version in the API hub. Multiple specs can be added to an API version. Note, while adding a spec, at least one of `contents` or `source_uri` must be provided. If `contents` is provided, then `spec_type` must also be provided. On adding a spec with contents to the version, the operations present in it will be added to the version.Note that the file contents in the spec should be of the same type as defined in the `projects/{project}/locations/{location}/attributes/system-spec-type` attribute associated with spec resource. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently. In order to access the information parsed from the spec, use the GetSpec method. In order to access the raw contents for a particular spec, use the GetSpecContents method. In order to access the operations parsed from the spec, use the ListAPIOperations method.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Delete a spec. Deleting a spec will also delete the associated operations from the version.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use GetSpecContents method to retrieve the same.</p>
<p class="toc_element">
<code><a href="#getContents">getContents(name, x__xgafv=None)</a></code></p>
<p class="firstline">Get spec contents.</p>
<p class="toc_element">
<code><a href="#lint">lint(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lints the requested spec and updates the corresponding API Spec with the lint response. This lint response will be available in all subsequent Get and List Spec calls to Core service.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">List specs corresponding to a particular API resource.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Update spec. The following fields in the spec can be updated: * display_name * source_uri * lint_response * attributes * contents * spec_type In case of an OAS spec, updating spec contents can lead to: 1. Creation, deletion and update of operations. 2. Creation, deletion and update of definitions. 3. Update of other info parsed out from the new spec. In case of contents or source_uri being present in update mask, spec_type must also be present. Also, spec_type can not be present in update mask if contents or source_uri is not present. The update_mask should be used to specify the fields being updated.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, specId=None, x__xgafv=None)</code>
<pre>Add a spec to an API version in the API hub. Multiple specs can be added to an API version. Note, while adding a spec, at least one of `contents` or `source_uri` must be provided. If `contents` is provided, then `spec_type` must also be provided. On adding a spec with contents to the version, the operations present in it will be added to the version.Note that the file contents in the spec should be of the same type as defined in the `projects/{project}/locations/{location}/attributes/system-spec-type` attribute associated with spec resource. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently. In order to access the information parsed from the spec, use the GetSpec method. In order to access the raw contents for a particular spec, use the GetSpecContents method. In order to access the operations parsed from the spec, use the ListAPIOperations method.
Args:
parent: string, Required. The parent resource for Spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}` (required)
body: object, The request body.
The object takes the form of:
{ # Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.
"attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
"a_key": { # The attribute values associated with resource.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
},
"contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec.
"contents": "A String", # Required. The contents of the spec.
"mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
},
"createTime": "A String", # Output only. The time at which the spec was created.
"details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec.
"description": "A String", # Output only. The description of the spec.
"openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method.
"format": "A String", # Output only. The format of the spec.
"owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec.
"displayName": "A String", # Optional. The name of the owner.
"email": "A String", # Required. The email of the owner.
},
"version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec.
},
},
"displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec.
"documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.
"externalUri": "A String", # Optional. The uri of the externally hosted documentation.
},
"lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec.
"createTime": "A String", # Required. Timestamp when the linting response was generated.
"issues": [ # Optional. Array of issues found in the analyzed document.
{ # Issue contains the details of a single issue found by the linter.
"code": "A String", # Required. Rule code unique to each rule defined in linter.
"message": "A String", # Required. Human-readable message describing the issue found by the linter.
"path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered.
"A String",
],
"range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found.
"end": { # Point within the file (line and character). # Required. End of the issue.
"character": 42, # Required. Character position within the line (zero-indexed).
"line": 42, # Required. Line number (zero-indexed).
},
"start": { # Point within the file (line and character). # Required. Start of the issue.
"character": 42, # Required. Character position within the line (zero-indexed).
"line": 42, # Required. Line number (zero-indexed).
},
},
"severity": "A String", # Required. Severity level of the rule violation.
},
],
"linter": "A String", # Required. Name of the linter used.
"source": "A String", # Required. Name of the linting application.
"state": "A String", # Required. Lint state represents success or failure for linting.
"summary": [ # Optional. Summary of all issue types and counts for each severity level.
{ # Count of issues with a given severity.
"count": 42, # Required. Count of issues with the given severity.
"severity": "A String", # Required. Severity of the issue.
},
],
},
"name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
"parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.
"sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec.
{ # SourceMetadata represents the metadata for a resource at the source.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
],
"sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system.
"specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"updateTime": "A String", # Output only. The time at which the spec was last updated.
}
specId: string, Optional. The ID to use for the spec, which will become the final component of the spec's resource name. This field is optional. * If provided, the same will be used. The service will throw an error if the specified id is already used by another spec in the API resource. * If not provided, a system generated id will be used. This value should be 4-500 characters, overall resource name which will be of format `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`, its length is limited to 1000 characters and valid characters are /a-z[0-9]-_/.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.
"attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
"a_key": { # The attribute values associated with resource.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
},
"contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec.
"contents": "A String", # Required. The contents of the spec.
"mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
},
"createTime": "A String", # Output only. The time at which the spec was created.
"details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec.
"description": "A String", # Output only. The description of the spec.
"openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method.
"format": "A String", # Output only. The format of the spec.
"owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec.
"displayName": "A String", # Optional. The name of the owner.
"email": "A String", # Required. The email of the owner.
},
"version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec.
},
},
"displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec.
"documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.
"externalUri": "A String", # Optional. The uri of the externally hosted documentation.
},
"lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec.
"createTime": "A String", # Required. Timestamp when the linting response was generated.
"issues": [ # Optional. Array of issues found in the analyzed document.
{ # Issue contains the details of a single issue found by the linter.
"code": "A String", # Required. Rule code unique to each rule defined in linter.
"message": "A String", # Required. Human-readable message describing the issue found by the linter.
"path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered.
"A String",
],
"range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found.
"end": { # Point within the file (line and character). # Required. End of the issue.
"character": 42, # Required. Character position within the line (zero-indexed).
"line": 42, # Required. Line number (zero-indexed).
},
"start": { # Point within the file (line and character). # Required. Start of the issue.
"character": 42, # Required. Character position within the line (zero-indexed).
"line": 42, # Required. Line number (zero-indexed).
},
},
"severity": "A String", # Required. Severity level of the rule violation.
},
],
"linter": "A String", # Required. Name of the linter used.
"source": "A String", # Required. Name of the linting application.
"state": "A String", # Required. Lint state represents success or failure for linting.
"summary": [ # Optional. Summary of all issue types and counts for each severity level.
{ # Count of issues with a given severity.
"count": 42, # Required. Count of issues with the given severity.
"severity": "A String", # Required. Severity of the issue.
},
],
},
"name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
"parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.
"sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec.
{ # SourceMetadata represents the metadata for a resource at the source.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
],
"sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system.
"specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"updateTime": "A String", # Output only. The time at which the spec was last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Delete a spec. Deleting a spec will also delete the associated operations from the version.
Args:
name: string, Required. The name of the spec to delete. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Get details about the information parsed from a spec. Note that this method does not return the raw spec contents. Use GetSpecContents method to retrieve the same.
Args:
name: string, Required. The name of the spec to retrieve. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.
"attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
"a_key": { # The attribute values associated with resource.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
},
"contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec.
"contents": "A String", # Required. The contents of the spec.
"mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
},
"createTime": "A String", # Output only. The time at which the spec was created.
"details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec.
"description": "A String", # Output only. The description of the spec.
"openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method.
"format": "A String", # Output only. The format of the spec.
"owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec.
"displayName": "A String", # Optional. The name of the owner.
"email": "A String", # Required. The email of the owner.
},
"version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec.
},
},
"displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec.
"documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.
"externalUri": "A String", # Optional. The uri of the externally hosted documentation.
},
"lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec.
"createTime": "A String", # Required. Timestamp when the linting response was generated.
"issues": [ # Optional. Array of issues found in the analyzed document.
{ # Issue contains the details of a single issue found by the linter.
"code": "A String", # Required. Rule code unique to each rule defined in linter.
"message": "A String", # Required. Human-readable message describing the issue found by the linter.
"path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered.
"A String",
],
"range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found.
"end": { # Point within the file (line and character). # Required. End of the issue.
"character": 42, # Required. Character position within the line (zero-indexed).
"line": 42, # Required. Line number (zero-indexed).
},
"start": { # Point within the file (line and character). # Required. Start of the issue.
"character": 42, # Required. Character position within the line (zero-indexed).
"line": 42, # Required. Line number (zero-indexed).
},
},
"severity": "A String", # Required. Severity level of the rule violation.
},
],
"linter": "A String", # Required. Name of the linter used.
"source": "A String", # Required. Name of the linting application.
"state": "A String", # Required. Lint state represents success or failure for linting.
"summary": [ # Optional. Summary of all issue types and counts for each severity level.
{ # Count of issues with a given severity.
"count": 42, # Required. Count of issues with the given severity.
"severity": "A String", # Required. Severity of the issue.
},
],
},
"name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
"parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.
"sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec.
{ # SourceMetadata represents the metadata for a resource at the source.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
],
"sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system.
"specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"updateTime": "A String", # Output only. The time at which the spec was last updated.
}</pre>
</div>
<div class="method">
<code class="details" id="getContents">getContents(name, x__xgafv=None)</code>
<pre>Get spec contents.
Args:
name: string, Required. The name of the spec whose contents need to be retrieved. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The spec contents.
"contents": "A String", # Required. The contents of the spec.
"mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
}</pre>
</div>
<div class="method">
<code class="details" id="lint">lint(name, body=None, x__xgafv=None)</code>
<pre>Lints the requested spec and updates the corresponding API Spec with the lint response. This lint response will be available in all subsequent Get and List Spec calls to Core service.
Args:
name: string, Required. The name of the spec to be linted. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` (required)
body: object, The request body.
The object takes the form of:
{ # The LintSpec method's request.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>List specs corresponding to a particular API resource.
Args:
parent: string, Required. The parent, which owns this collection of specs. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}` (required)
filter: string, Optional. An expression that filters the list of Specs. A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string. The comparison operator must be one of: `<`, `>`, `:` or `=`. Filters are not case sensitive. The following fields in the `Spec` are eligible for filtering: * `display_name` - The display name of the Spec. Allowed comparison operators: `=`. * `create_time` - The time at which the Spec was created. The value should be in the (RFC3339)[https://tools.ietf.org/html/rfc3339] format. Allowed comparison operators: `>` and `<`. * `spec_type.enum_values.values.id` - The allowed value id of the spec_type attribute associated with the Spec. Allowed comparison operators: `:`. * `spec_type.enum_values.values.display_name` - The allowed value display name of the spec_type attribute associated with the Spec. Allowed comparison operators: `:`. * `lint_response.json_values.values` - The json value of the lint_response attribute associated with the Spec. Allowed comparison operators: `:`. * `mime_type` - The MIME type of the Spec. Allowed comparison operators: `=`. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.id` - The allowed value id of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-id is a placeholder that can be replaced with any user defined enum attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.enum_values.values.display_name` - The allowed value display name of the user defined enum attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-enum-display-name is a placeholder that can be replaced with any user defined enum attribute enum name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.string_values.values` - The allowed value of the user defined string attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-string is a placeholder that can be replaced with any user defined string attribute name. * `attributes.projects/test-project-id/locations/test-location-id/ attributes/user-defined-attribute-id.json_values.values` - The allowed value of the user defined JSON attribute associated with the Resource. Allowed comparison operator is `:`. Here user-defined-attribute-json is a placeholder that can be replaced with any user defined JSON attribute name. Expressions are combined with either `AND` logic operator or `OR` logical operator but not both of them together i.e. only one of the `AND` or `OR` operator can be used throughout the filter string and both the operators cannot be used together. No other logical operators are supported. At most three filter fields are allowed in the filter string and if provided more than that then `INVALID_ARGUMENT` error is returned by the API. Here are a few examples: * `spec_type.enum_values.values.id: rest-id` - The filter string specifies that the id of the allowed value associated with the spec_type attribute is _rest-id_. * `spec_type.enum_values.values.display_name: \"Rest Display Name\"` - The filter string specifies that the display name of the allowed value associated with the spec_type attribute is `Rest Display Name`. * `spec_type.enum_values.values.id: grpc-id AND create_time < \"2021-08-15T14:50:00Z\" AND create_time > \"2021-08-10T12:00:00Z\"` - The id of the allowed value associated with the spec_type attribute is _grpc-id_ and the spec was created before _2021-08-15 14:50:00 UTC_ and after _2021-08-10 12:00:00 UTC_. * `spec_type.enum_values.values.id: rest-id OR spec_type.enum_values.values.id: grpc-id` - The id of the allowed value associated with the spec_type attribute is _rest-id_ or _grpc-id_. * `spec_type.enum_values.values.id: rest-id AND attributes.projects/test-project-id/locations/test-location-id/ attributes/17650f90-4a29-4971-b3c0-d5532da3764b.enum_values.values.id: test` - The filter string specifies that the id of the allowed value associated with the spec_type attribute is _rest-id_ and the id of the allowed value associated with the user defined attribute of type enum is _test_.
pageSize: integer, Optional. The maximum number of specs to return. The service may return fewer than this value. If unspecified, at most 50 specs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `ListSpecs` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListSpecs` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The ListSpecs method's response.
"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
"specs": [ # The specs corresponding to an API Version.
{ # Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.
"attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
"a_key": { # The attribute values associated with resource.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
},
"contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec.
"contents": "A String", # Required. The contents of the spec.
"mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
},
"createTime": "A String", # Output only. The time at which the spec was created.
"details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec.
"description": "A String", # Output only. The description of the spec.
"openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method.
"format": "A String", # Output only. The format of the spec.
"owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec.
"displayName": "A String", # Optional. The name of the owner.
"email": "A String", # Required. The email of the owner.
},
"version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec.
},
},
"displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec.
"documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.
"externalUri": "A String", # Optional. The uri of the externally hosted documentation.
},
"lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec.
"createTime": "A String", # Required. Timestamp when the linting response was generated.
"issues": [ # Optional. Array of issues found in the analyzed document.
{ # Issue contains the details of a single issue found by the linter.
"code": "A String", # Required. Rule code unique to each rule defined in linter.
"message": "A String", # Required. Human-readable message describing the issue found by the linter.
"path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered.
"A String",
],
"range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found.
"end": { # Point within the file (line and character). # Required. End of the issue.
"character": 42, # Required. Character position within the line (zero-indexed).
"line": 42, # Required. Line number (zero-indexed).
},
"start": { # Point within the file (line and character). # Required. Start of the issue.
"character": 42, # Required. Character position within the line (zero-indexed).
"line": 42, # Required. Line number (zero-indexed).
},
},
"severity": "A String", # Required. Severity level of the rule violation.
},
],
"linter": "A String", # Required. Name of the linter used.
"source": "A String", # Required. Name of the linting application.
"state": "A String", # Required. Lint state represents success or failure for linting.
"summary": [ # Optional. Summary of all issue types and counts for each severity level.
{ # Count of issues with a given severity.
"count": 42, # Required. Count of issues with the given severity.
"severity": "A String", # Required. Severity of the issue.
},
],
},
"name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
"parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.
"sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec.
{ # SourceMetadata represents the metadata for a resource at the source.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
],
"sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system.
"specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"updateTime": "A String", # Output only. The time at which the spec was last updated.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Update spec. The following fields in the spec can be updated: * display_name * source_uri * lint_response * attributes * contents * spec_type In case of an OAS spec, updating spec contents can lead to: 1. Creation, deletion and update of operations. 2. Creation, deletion and update of definitions. 3. Update of other info parsed out from the new spec. In case of contents or source_uri being present in update mask, spec_type must also be present. Also, spec_type can not be present in update mask if contents or source_uri is not present. The update_mask should be used to specify the fields being updated.
Args:
name: string, Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}` (required)
body: object, The request body.
The object takes the form of:
{ # Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.
"attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
"a_key": { # The attribute values associated with resource.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
},
"contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec.
"contents": "A String", # Required. The contents of the spec.
"mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
},
"createTime": "A String", # Output only. The time at which the spec was created.
"details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec.
"description": "A String", # Output only. The description of the spec.
"openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method.
"format": "A String", # Output only. The format of the spec.
"owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec.
"displayName": "A String", # Optional. The name of the owner.
"email": "A String", # Required. The email of the owner.
},
"version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec.
},
},
"displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec.
"documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.
"externalUri": "A String", # Optional. The uri of the externally hosted documentation.
},
"lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec.
"createTime": "A String", # Required. Timestamp when the linting response was generated.
"issues": [ # Optional. Array of issues found in the analyzed document.
{ # Issue contains the details of a single issue found by the linter.
"code": "A String", # Required. Rule code unique to each rule defined in linter.
"message": "A String", # Required. Human-readable message describing the issue found by the linter.
"path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered.
"A String",
],
"range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found.
"end": { # Point within the file (line and character). # Required. End of the issue.
"character": 42, # Required. Character position within the line (zero-indexed).
"line": 42, # Required. Line number (zero-indexed).
},
"start": { # Point within the file (line and character). # Required. Start of the issue.
"character": 42, # Required. Character position within the line (zero-indexed).
"line": 42, # Required. Line number (zero-indexed).
},
},
"severity": "A String", # Required. Severity level of the rule violation.
},
],
"linter": "A String", # Required. Name of the linter used.
"source": "A String", # Required. Name of the linting application.
"state": "A String", # Required. Lint state represents success or failure for linting.
"summary": [ # Optional. Summary of all issue types and counts for each severity level.
{ # Count of issues with a given severity.
"count": 42, # Required. Count of issues with the given severity.
"severity": "A String", # Required. Severity of the issue.
},
],
},
"name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
"parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.
"sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec.
{ # SourceMetadata represents the metadata for a resource at the source.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
],
"sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system.
"specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"updateTime": "A String", # Output only. The time at which the spec was last updated.
}
updateMask: string, Required. The list of fields to update.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Represents a spec associated with an API version in the API Hub. Note that specs of various types can be uploaded, however parsing of details is supported for OpenAPI spec currently.
"attributes": { # Optional. The list of user defined attributes associated with the spec. The key is the attribute name. It will be of the format: `projects/{project}/locations/{location}/attributes/{attribute}`. The value is the attribute values associated with the resource.
"a_key": { # The attribute values associated with resource.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
},
"contents": { # The spec contents. # Optional. Input only. The contents of the uploaded spec.
"contents": "A String", # Required. The contents of the spec.
"mimeType": "A String", # Required. The mime type of the content for example application/json, application/yaml, application/wsdl etc.
},
"createTime": "A String", # Output only. The time at which the spec was created.
"details": { # SpecDetails contains the details parsed from supported spec types. # Output only. Details parsed from the spec.
"description": "A String", # Output only. The description of the spec.
"openApiSpecDetails": { # OpenApiSpecDetails contains the details parsed from an OpenAPI spec in addition to the fields mentioned in SpecDetails. # Output only. Additional details apart from `OperationDetails` parsed from an OpenAPI spec. The OperationDetails parsed from the spec can be obtained by using ListAPIOperations method.
"format": "A String", # Output only. The format of the spec.
"owner": { # Owner details. # Output only. Owner details for the spec. This maps to `info.contact` in OpenAPI spec.
"displayName": "A String", # Optional. The name of the owner.
"email": "A String", # Required. The email of the owner.
},
"version": "A String", # Output only. The version in the spec. This maps to `info.version` in OpenAPI spec.
},
},
"displayName": "A String", # Required. The display name of the spec. This can contain the file name of the spec.
"documentation": { # Documentation details. # Optional. The documentation of the spec. For OpenAPI spec, this will be populated from `externalDocs` in OpenAPI spec.
"externalUri": "A String", # Optional. The uri of the externally hosted documentation.
},
"lintResponse": { # LintResponse contains the response from the linter. # Optional. The lint response for the spec.
"createTime": "A String", # Required. Timestamp when the linting response was generated.
"issues": [ # Optional. Array of issues found in the analyzed document.
{ # Issue contains the details of a single issue found by the linter.
"code": "A String", # Required. Rule code unique to each rule defined in linter.
"message": "A String", # Required. Human-readable message describing the issue found by the linter.
"path": [ # Required. An array of strings indicating the location in the analyzed document where the rule was triggered.
"A String",
],
"range": { # Object describing where in the file the issue was found. # Required. Object describing where in the file the issue was found.
"end": { # Point within the file (line and character). # Required. End of the issue.
"character": 42, # Required. Character position within the line (zero-indexed).
"line": 42, # Required. Line number (zero-indexed).
},
"start": { # Point within the file (line and character). # Required. Start of the issue.
"character": 42, # Required. Character position within the line (zero-indexed).
"line": 42, # Required. Line number (zero-indexed).
},
},
"severity": "A String", # Required. Severity level of the rule violation.
},
],
"linter": "A String", # Required. Name of the linter used.
"source": "A String", # Required. Name of the linting application.
"state": "A String", # Required. Lint state represents success or failure for linting.
"summary": [ # Optional. Summary of all issue types and counts for each severity level.
{ # Count of issues with a given severity.
"count": 42, # Required. Count of issues with the given severity.
"severity": "A String", # Required. Severity of the issue.
},
],
},
"name": "A String", # Identifier. The name of the spec. Format: `projects/{project}/locations/{location}/apis/{api}/versions/{version}/specs/{spec}`
"parsingMode": "A String", # Optional. Input only. Enum specifying the parsing mode for OpenAPI Specification (OAS) parsing.
"sourceMetadata": [ # Output only. The list of sources and metadata from the sources of the spec.
{ # SourceMetadata represents the metadata for a resource at the source.
"originalResourceCreateTime": "A String", # Output only. The time at which the resource was created at the source.
"originalResourceId": "A String", # Output only. The unique identifier of the resource at the source.
"originalResourceUpdateTime": "A String", # Output only. The time at which the resource was last updated at the source.
"pluginInstanceActionSource": { # PluginInstanceActionSource represents the plugin instance action source. # Output only. The source of the resource is a plugin instance action.
"actionId": "A String", # Output only. The id of the plugin instance action.
"pluginInstance": "A String", # Output only. The resource name of the source plugin instance. Format is `projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}`
},
"sourceType": "A String", # Output only. The type of the source.
},
],
"sourceUri": "A String", # Optional. The URI of the spec source in case file is uploaded from an external version control system.
"specType": { # The attribute values associated with resource. # Required. The type of spec. The value should be one of the allowed values defined for `projects/{project}/locations/{location}/attributes/system-spec-type` attribute. The number of values for this attribute will be based on the cardinality of the attribute. The same can be retrieved via GetAttribute API. Note, this field is mandatory if content is provided.
"attribute": "A String", # Output only. The name of the attribute. Format: projects/{project}/locations/{location}/attributes/{attribute}
"enumValues": { # The attribute values of data type enum. # The attribute values associated with a resource in case attribute data type is enum.
"values": [ # Required. The attribute values in case attribute data type is enum.
{ # The value that can be assigned to the attribute when the data type is enum.
"description": "A String", # Optional. The detailed description of the allowed value.
"displayName": "A String", # Required. The display name of the allowed value.
"id": "A String", # Required. The ID of the allowed value. * If provided, the same will be used. The service will throw an error if the specified id is already used by another allowed value in the same attribute resource. * If not provided, a system generated id derived from the display name will be used. In this case, the service will handle conflict resolution by adding a system generated suffix in case of duplicates. This value should be 4-63 characters, and valid characters are /a-z-/.
"immutable": True or False, # Optional. When set to true, the allowed value cannot be updated or deleted by the user. It can only be true for System defined attributes.
},
],
},
"jsonValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is JSON.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"stringValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is string.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
"uriValues": { # The attribute values of data type string or JSON. # The attribute values associated with a resource in case attribute data type is URL, URI or IP, like gs://bucket-name/object-name.
"values": [ # Required. The attribute values in case attribute data type is string or JSON.
"A String",
],
},
},
"updateTime": "A String", # Output only. The time at which the spec was last updated.
}</pre>
</div>
</body></html>
|
