Skip to content

Commit d42b431

Browse files
yoshi-automationsofisl
yoshi-automation
authored and
sofisl
committed
feat(storage): update the API
#### storage:v1 The following keys were added: - resources.buckets.methods.get.parameters.generation.description - resources.buckets.methods.get.parameters.generation.format - resources.buckets.methods.get.parameters.generation.location - resources.buckets.methods.get.parameters.generation.type - resources.buckets.methods.get.parameters.softDeleted.description - resources.buckets.methods.get.parameters.softDeleted.location - resources.buckets.methods.get.parameters.softDeleted.type - resources.buckets.methods.list.parameters.softDeleted.description - resources.buckets.methods.list.parameters.softDeleted.location - resources.buckets.methods.list.parameters.softDeleted.type - resources.buckets.methods.restore.description - resources.buckets.methods.restore.httpMethod - resources.buckets.methods.restore.id - resources.buckets.methods.restore.parameterOrder - resources.buckets.methods.restore.parameters.bucket.description - resources.buckets.methods.restore.parameters.bucket.location - resources.buckets.methods.restore.parameters.bucket.required - resources.buckets.methods.restore.parameters.bucket.type - resources.buckets.methods.restore.parameters.generation.description - resources.buckets.methods.restore.parameters.generation.format - resources.buckets.methods.restore.parameters.generation.location - resources.buckets.methods.restore.parameters.generation.required - resources.buckets.methods.restore.parameters.generation.type - resources.buckets.methods.restore.parameters.userProject.description - resources.buckets.methods.restore.parameters.userProject.location - resources.buckets.methods.restore.parameters.userProject.type - resources.buckets.methods.restore.path - resources.buckets.methods.restore.scopes - schemas.Bucket.properties.generation.description - schemas.Bucket.properties.generation.format - schemas.Bucket.properties.generation.type - schemas.Bucket.properties.ipFilter.description - schemas.Bucket.properties.ipFilter.properties.mode.description - schemas.Bucket.properties.ipFilter.properties.mode.type - schemas.Bucket.properties.ipFilter.properties.publicNetworkSource.description - schemas.Bucket.properties.ipFilter.properties.publicNetworkSource.properties.allowedIpCidrRanges.description - schemas.Bucket.properties.ipFilter.properties.publicNetworkSource.properties.allowedIpCidrRanges.items.type - schemas.Bucket.properties.ipFilter.properties.publicNetworkSource.properties.allowedIpCidrRanges.type - schemas.Bucket.properties.ipFilter.properties.publicNetworkSource.type - schemas.Bucket.properties.ipFilter.properties.vpcNetworkSources.description - schemas.Bucket.properties.ipFilter.properties.vpcNetworkSources.items.properties.allowedIpCidrRanges.description - schemas.Bucket.properties.ipFilter.properties.vpcNetworkSources.items.properties.allowedIpCidrRanges.items.type - schemas.Bucket.properties.ipFilter.properties.vpcNetworkSources.items.properties.allowedIpCidrRanges.type - schemas.Bucket.properties.ipFilter.properties.vpcNetworkSources.items.properties.network.description - schemas.Bucket.properties.ipFilter.properties.vpcNetworkSources.items.properties.network.type - schemas.Bucket.properties.ipFilter.properties.vpcNetworkSources.items.type - schemas.Bucket.properties.ipFilter.properties.vpcNetworkSources.type - schemas.Bucket.properties.ipFilter.type - schemas.Bucket.properties.satisfiesPZI.description - schemas.Bucket.properties.satisfiesPZI.type The following keys were changed: - resources.buckets.methods.delete.description - resources.objects.methods.get.parameters.softDeleted.description - resources.objects.methods.list.parameters.softDeleted.description - resources.objects.methods.list.parameters.versions.description - resources.objects.methods.restore.parameters.object.description - resources.objects.methods.watchAll.parameters.versions.description - resources.projects.resources.hmacKeys.methods.update.description - schemas.Bucket.properties.lifecycle.description - schemas.Bucket.properties.location.description - schemas.Bucket.properties.storageClass.description - schemas.Bucket.properties.website.description - schemas.Object.properties.crc32c.description - schemas.Object.properties.md5Hash.description
1 parent e20497e commit d42b431

File tree

2 files changed

+267
-34
lines changed

2 files changed

+267
-34
lines changed

‎discovery/storage-v1.json

Lines changed: 124 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -28,22 +28,22 @@
2828
"documentationLink": "https://developers.google.com/storage/docs/json_api/",
2929
"endpoints": [
3030
{
31+
"description": "Regional Endpoint",
3132
"endpointUrl": "https://storage.europe-west3.rep.googleapis.com/",
32-
"location": "europe-west3",
33-
"description": "Regional Endpoint"
33+
"location": "europe-west3"
3434
},
3535
{
36+
"description": "Regional Endpoint",
3637
"endpointUrl": "https://storage.europe-west9.rep.googleapis.com/",
37-
"location": "europe-west9",
38-
"description": "Regional Endpoint"
38+
"location": "europe-west9"
3939
},
4040
{
41+
"description": "Regional Endpoint",
4142
"endpointUrl": "https://storage.me-central2.rep.googleapis.com/",
42-
"location": "me-central2",
43-
"description": "Regional Endpoint"
43+
"location": "me-central2"
4444
}
4545
],
46-
"etag": "\"39393931363036383932333134343736343437\"",
46+
"etag": "\"34373939373134303235393739323331393435\"",
4747
"icons": {
4848
"x16": "https://www.google.com/images/icons/product/cloud_storage-16.png",
4949
"x32": "https://www.google.com/images/icons/product/cloud_storage-32.png"
@@ -560,7 +560,7 @@
560560
"buckets": {
561561
"methods": {
562562
"delete": {
563-
"description": "Permanently deletes an empty bucket.",
563+
"description": "Deletes an empty bucket. Deletions are permanent unless soft delete is enabled on the bucket.",
564564
"httpMethod": "DELETE",
565565
"id": "storage.buckets.delete",
566566
"parameterOrder": [
@@ -612,6 +612,12 @@
612612
"required": true,
613613
"type": "string"
614614
},
615+
"generation": {
616+
"description": "If present, specifies the generation of the bucket. This is required if softDeleted is true.",
617+
"format": "int64",
618+
"location": "query",
619+
"type": "string"
620+
},
615621
"ifMetagenerationMatch": {
616622
"description": "Makes the return of the bucket metadata conditional on whether the bucket's current metageneration matches the given value.",
617623
"format": "int64",
@@ -637,6 +643,11 @@
637643
"location": "query",
638644
"type": "string"
639645
},
646+
"softDeleted": {
647+
"description": "If true, return the soft-deleted version of this bucket. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete).",
648+
"location": "query",
649+
"type": "boolean"
650+
},
640651
"userProject": {
641652
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
642653
"location": "query",
@@ -860,6 +871,11 @@
860871
"location": "query",
861872
"type": "string"
862873
},
874+
"softDeleted": {
875+
"description": "If true, only soft-deleted bucket versions will be returned. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete).",
876+
"location": "query",
877+
"type": "boolean"
878+
},
863879
"userProject": {
864880
"description": "The project to be billed for this request.",
865881
"location": "query",
@@ -1013,6 +1029,41 @@
10131029
"https://www.googleapis.com/auth/devstorage.full_control"
10141030
]
10151031
},
1032+
"restore": {
1033+
"description": "Restores a soft-deleted bucket.",
1034+
"httpMethod": "POST",
1035+
"id": "storage.buckets.restore",
1036+
"parameterOrder": [
1037+
"bucket",
1038+
"generation"
1039+
],
1040+
"parameters": {
1041+
"bucket": {
1042+
"description": "Name of a bucket.",
1043+
"location": "path",
1044+
"required": true,
1045+
"type": "string"
1046+
},
1047+
"generation": {
1048+
"description": "Generation of a bucket.",
1049+
"format": "int64",
1050+
"location": "query",
1051+
"required": true,
1052+
"type": "string"
1053+
},
1054+
"userProject": {
1055+
"description": "The project to be billed for this request. Required for Requester Pays buckets.",
1056+
"location": "query",
1057+
"type": "string"
1058+
}
1059+
},
1060+
"path": "b/{bucket}/restore",
1061+
"scopes": [
1062+
"https://www.googleapis.com/auth/cloud-platform",
1063+
"https://www.googleapis.com/auth/devstorage.full_control",
1064+
"https://www.googleapis.com/auth/devstorage.read_write"
1065+
]
1066+
},
10161067
"setIamPolicy": {
10171068
"description": "Updates an IAM policy for the specified bucket.",
10181069
"httpMethod": "PUT",
@@ -2779,7 +2830,7 @@
27792830
"type": "string"
27802831
},
27812832
"softDeleted": {
2782-
"description": "If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.",
2833+
"description": "If true, only soft-deleted object versions will be listed. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete).",
27832834
"location": "query",
27842835
"type": "boolean"
27852836
},
@@ -3041,7 +3092,7 @@
30413092
"type": "string"
30423093
},
30433094
"softDeleted": {
3044-
"description": "If true, only soft-deleted object versions will be listed. The default is false. For more information, see Soft Delete.",
3095+
"description": "If true, only soft-deleted object versions will be listed. The default is false. For more information, see [Soft Delete](https://cloud.google.com/storage/docs/soft-delete).",
30453096
"location": "query",
30463097
"type": "boolean"
30473098
},
@@ -3056,7 +3107,7 @@
30563107
"type": "string"
30573108
},
30583109
"versions": {
3059-
"description": "If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.",
3110+
"description": "If true, lists all versions of an object as distinct results. The default is false. For more information, see [Object Versioning](https://cloud.google.com/storage/docs/object-versioning).",
30603111
"location": "query",
30613112
"type": "boolean"
30623113
}
@@ -3235,7 +3286,7 @@
32353286
"type": "string"
32363287
},
32373288
"object": {
3238-
"description": "Name of the object. For information about how to URL encode object names to be path safe, see Encoding URI Path Parts.",
3289+
"description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).",
32393290
"location": "path",
32403291
"required": true,
32413292
"type": "string"
@@ -3704,7 +3755,7 @@
37043755
"type": "string"
37053756
},
37063757
"versions": {
3707-
"description": "If true, lists all versions of an object as distinct results. The default is false. For more information, see Object Versioning.",
3758+
"description": "If true, lists all versions of an object as distinct results. The default is false. For more information, see [Object Versioning](https://cloud.google.com/storage/docs/object-versioning).",
37083759
"location": "query",
37093760
"type": "boolean"
37103761
}
@@ -4006,7 +4057,7 @@
40064057
]
40074058
},
40084059
"update": {
4009-
"description": "Updates the state of an HMAC key. See the HMAC Key resource descriptor for valid states.",
4060+
"description": "Updates the state of an HMAC key. See the [HMAC Key resource descriptor](https://cloud.google.com/storage/docs/json_api/v1/projects/hmacKeys/update#request-body) for valid states.",
40104061
"httpMethod": "PUT",
40114062
"id": "storage.projects.hmacKeys.update",
40124063
"parameterOrder": [
@@ -4085,7 +4136,7 @@
40854136
}
40864137
}
40874138
},
4088-
"revision": "20240625",
4139+
"revision": "20240809",
40894140
"rootUrl": "https://storage.googleapis.com/",
40904141
"schemas": {
40914142
"AnywhereCache": {
@@ -4293,6 +4344,11 @@
42934344
"description": "HTTP 1.1 Entity tag for the bucket.",
42944345
"type": "string"
42954346
},
4347+
"generation": {
4348+
"description": "The generation of this bucket.",
4349+
"format": "int64",
4350+
"type": "string"
4351+
},
42964352
"hierarchicalNamespace": {
42974353
"description": "The bucket's hierarchical namespace configuration.",
42984354
"properties": {
@@ -4347,6 +4403,49 @@
43474403
"description": "The ID of the bucket. For buckets, the id and name properties are the same.",
43484404
"type": "string"
43494405
},
4406+
"ipFilter": {
4407+
"description": "The bucket's IP filter configuration. Specifies the network sources that are allowed to access the operations on the bucket, as well as its underlying objects. Only enforced when the mode is set to 'Enabled'.",
4408+
"properties": {
4409+
"mode": {
4410+
"description": "The mode of the IP filter. Valid values are 'Enabled' and 'Disabled'.",
4411+
"type": "string"
4412+
},
4413+
"publicNetworkSource": {
4414+
"description": "The public network source of the bucket's IP filter.",
4415+
"properties": {
4416+
"allowedIpCidrRanges": {
4417+
"description": "The list of public IPv4, IPv6 cidr ranges that are allowed to access the bucket.",
4418+
"items": {
4419+
"type": "string"
4420+
},
4421+
"type": "array"
4422+
}
4423+
},
4424+
"type": "object"
4425+
},
4426+
"vpcNetworkSources": {
4427+
"description": "The list of [VPC network](https://cloud.google.com/vpc/docs/vpc) sources of the bucket's IP filter.",
4428+
"items": {
4429+
"properties": {
4430+
"allowedIpCidrRanges": {
4431+
"description": "The list of IPv4, IPv6 cidr ranges subnetworks that are allowed to access the bucket.",
4432+
"items": {
4433+
"type": "string"
4434+
},
4435+
"type": "array"
4436+
},
4437+
"network": {
4438+
"description": "Name of the network. Format: projects/{PROJECT_ID}/global/networks/{NETWORK_NAME}",
4439+
"type": "string"
4440+
}
4441+
},
4442+
"type": "object"
4443+
},
4444+
"type": "array"
4445+
}
4446+
},
4447+
"type": "object"
4448+
},
43504449
"kind": {
43514450
"default": "storage#bucket",
43524451
"description": "The kind of item this is. For buckets, this is always storage#bucket.",
@@ -4361,7 +4460,7 @@
43614460
"type": "object"
43624461
},
43634462
"lifecycle": {
4364-
"description": "The bucket's lifecycle configuration. See lifecycle management for more information.",
4463+
"description": "The bucket's lifecycle configuration. See [Lifecycle Management](https://cloud.google.com/storage/docs/lifecycle) for more information.",
43654464
"properties": {
43664465
"rule": {
43674466
"description": "A lifecycle management rule, which is made of an action to take and the condition(s) under which the action will be taken.",
@@ -4460,7 +4559,7 @@
44604559
"type": "object"
44614560
},
44624561
"location": {
4463-
"description": "The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the developer's guide for the authoritative list.",
4562+
"description": "The location of the bucket. Object data for objects in the bucket resides in physical storage within this region. Defaults to US. See the [Developer's Guide](https://cloud.google.com/storage/docs/locations) for the authoritative list.",
44644563
"type": "string"
44654564
},
44664565
"locationType": {
@@ -4548,6 +4647,10 @@
45484647
"description": "The Recovery Point Objective (RPO) of this bucket. Set to ASYNC_TURBO to turn on Turbo Replication on a bucket.",
45494648
"type": "string"
45504649
},
4650+
"satisfiesPZI": {
4651+
"description": "Reserved for future use.",
4652+
"type": "boolean"
4653+
},
45514654
"satisfiesPZS": {
45524655
"description": "Reserved for future use.",
45534656
"type": "boolean"
@@ -4573,7 +4676,7 @@
45734676
"type": "object"
45744677
},
45754678
"storageClass": {
4576-
"description": "The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see storage classes.",
4679+
"description": "The bucket's default storage class, used whenever no storageClass is specified for a newly-created object. This defines how objects in the bucket are stored and determines the SLA and the cost of storage. Values include MULTI_REGIONAL, REGIONAL, STANDARD, NEARLINE, COLDLINE, ARCHIVE, and DURABLE_REDUCED_AVAILABILITY. If this value is not specified when the bucket is created, it will default to STANDARD. For more information, see [Storage Classes](https://cloud.google.com/storage/docs/storage-classes).",
45774680
"type": "string"
45784681
},
45794682
"timeCreated": {
@@ -4597,7 +4700,7 @@
45974700
"type": "object"
45984701
},
45994702
"website": {
4600-
"description": "The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the Static Website Examples for more information.",
4703+
"description": "The bucket's website configuration, controlling how the service behaves when accessing bucket contents as a web site. See the [Static Website Examples](https://cloud.google.com/storage/docs/static-website) for more information.",
46014704
"properties": {
46024705
"mainPageSuffix": {
46034706
"description": "If the requested object path is missing, the service will ensure the path has a trailing '/', append this suffix, and attempt to retrieve the resulting object. This allows the creation of index.html objects to represent directory pages.",
@@ -5392,7 +5495,7 @@
53925495
"type": "string"
53935496
},
53945497
"crc32c": {
5395-
"description": "CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see Hashes and ETags: Best Practices.",
5498+
"description": "CRC32c checksum, as described in RFC 4960, Appendix B; encoded using base64 in big-endian byte order. For more information about using the CRC32c checksum, see [Data Validation and Change Detection](https://cloud.google.com/storage/docs/data-validation).",
53965499
"type": "string"
53975500
},
53985501
"customTime": {
@@ -5446,7 +5549,7 @@
54465549
"type": "string"
54475550
},
54485551
"md5Hash": {
5449-
"description": "MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see Hashes and ETags: Best Practices.",
5552+
"description": "MD5 hash of the data; encoded using base64. For more information about using the MD5 hash, see [Data Validation and Change Detection](https://cloud.google.com/storage/docs/data-validation).",
54505553
"type": "string"
54515554
},
54525555
"mediaLink": {

0 commit comments

Comments
 (0)