Skip to content

Commit 427cfdd

Browse files
authored
fix(object): rename 'S3' to 'Object Storage' or 'Amazon S3' to address compliance requirements (#1537)
1 parent f895c19 commit 427cfdd

File tree

7 files changed

+33
-27
lines changed

7 files changed

+33
-27
lines changed

packages/clients/src/api/inference/v1beta1/types.gen.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ export interface Model {
166166
tags: string[]
167167
/** Purpose of the model. */
168168
description: string
169-
/** Defines whether the model has an end user licence agreement. */
169+
/** Defines whether the model has an end user license agreement. */
170170
hasEula: boolean
171171
/** Creation date of the model. */
172172
createdAt?: Date
@@ -175,7 +175,7 @@ export interface Model {
175175
/** Region of the model. */
176176
region: Region
177177
/**
178-
* S3 URL pointing to the model source weight.
178+
* Object Storage URL pointing to the model source weight.
179179
*
180180
* One-of ('source'): at most one of 's3Model' could be set.
181181
*/
@@ -304,7 +304,7 @@ export type DeleteEndpointRequest = {
304304
}
305305

306306
export interface Eula {
307-
/** Content of the end user licence agreement. */
307+
/** Content of the end user license agreement. */
308308
content: string
309309
}
310310

packages/clients/src/api/instance/v1/api.gen.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -745,8 +745,8 @@ export class API extends ParentAPI {
745745
})
746746

747747
/**
748-
* Export a snapshot. Export a snapshot to a specified S3 bucket in the same
749-
* region.
748+
* Export a snapshot. Export a snapshot to a specified Object Storage bucket
749+
* in the same region.
750750
*
751751
* @param request - The request {@link ExportSnapshotRequest}
752752
* @returns A Promise of ExportSnapshotResponse

packages/clients/src/api/instance/v1/types.gen.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1223,9 +1223,9 @@ export type ExportSnapshotRequest = {
12231223
zone?: Zone
12241224
/** Snapshot ID. */
12251225
snapshotId: string
1226-
/** S3 bucket name. */
1226+
/** Object Storage bucket name. */
12271227
bucket: string
1228-
/** S3 object key. */
1228+
/** Object key. */
12291229
key: string
12301230
}
12311231

packages/clients/src/api/iot/v1/api.gen.ts

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -562,9 +562,10 @@ export class API extends ParentAPI {
562562
* into your database. <b>You need to manage the database by yourself</b>.
563563
* - REST Route. Create a route that will call a REST API on received subscribed
564564
* MQTT messages.
565-
* - S3 Routes. Create a route that will put subscribed MQTT messages into an S3
566-
* bucket. You need to create the bucket yourself and grant write access.
567-
* Granting can be done with s3cmd (`s3cmd setacl s3://<my-bucket>
565+
* - Amazon S3 Routes. Create a route that will put subscribed MQTT messages
566+
* into an Object Storage bucket. You need to create the bucket yourself and
567+
* grant write access. Granting can be done with s3cmd (`s3cmd setacl
568+
* s3://<my-bucket>
568569
* --acl-grant=write:555c69c3-87d0-4bf8-80f1-99a2f757d031:555c69c3-87d0-4bf8-80f1-99a2f757d031`).
569570
*
570571
* @param request - The request {@link CreateRouteRequest}

packages/clients/src/api/iot/v1/types.gen.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -304,14 +304,14 @@ export interface RouteRestConfig {
304304
}
305305

306306
export interface RouteS3Config {
307-
/** Region of the S3 route's destination bucket (e.g., 'fr-par'). */
307+
/** Region of the Amazon S3 route's destination bucket (e.g., 'fr-par'). */
308308
bucketRegion: string
309-
/** Destination bucket name of the S3 route. */
309+
/** Destination bucket name of the Amazon S3 route. */
310310
bucketName: string
311311
/** Optional string to prefix object names with. */
312312
objectPrefix: string
313313
/**
314-
* How the S3 route's objects will be created: one per topic or one per
314+
* How the Amazon S3 route's objects will be created: one per topic or one per
315315
* message.
316316
*/
317317
strategy: RouteS3ConfigS3Strategy
@@ -443,7 +443,7 @@ export type CreateRouteRequest = {
443443
*/
444444
topic: string
445445
/**
446-
* If creating S3 Route, S3-specific configuration fields.
446+
* If creating Amazon S3 Routes, Amazon S3-specific configuration fields.
447447
*
448448
* One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig'
449449
* could be set.
@@ -890,7 +890,7 @@ export interface Route {
890890
/** Date at which the route was created. */
891891
createdAt?: Date
892892
/**
893-
* When using S3 Route, S3-specific configuration fields.
893+
* When using Amazon S3 Routes, Amazon S3-specific configuration fields.
894894
*
895895
* One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig'
896896
* could be set.
@@ -1029,7 +1029,7 @@ export type UpdateRouteRequest = {
10291029
*/
10301030
topic?: string
10311031
/**
1032-
* When updating S3 Route, S3-specific configuration fields.
1032+
* When updating Amazon S3 Route, Amazon S3-specific configuration fields.
10331033
*
10341034
* One-of ('config'): at most one of 's3Config', 'dbConfig', 'restConfig'
10351035
* could be set.

packages/clients/src/api/lb/v1/types.gen.ts

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -452,8 +452,9 @@ export interface Backend {
452452
/** Date at which the backend was updated. */
453453
updatedAt?: Date
454454
/**
455-
* Scaleway S3 bucket website to be served as failover if all backend servers
456-
* are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
455+
* Scaleway Object Storage bucket website to be served as failover if all
456+
* backend servers are down, e.g.
457+
* failover-website.s3-website.fr-par.scw.cloud.
457458
*/
458459
failoverHost?: string
459460
/**
@@ -893,8 +894,9 @@ export type CreateBackendRequest = {
893894
*/
894895
proxyProtocol?: ProxyProtocol
895896
/**
896-
* Scaleway S3 bucket website to be served as failover if all backend servers
897-
* are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
897+
* Scaleway Object Storage bucket website to be served as failover if all
898+
* backend servers are down, e.g.
899+
* failover-website.s3-website.fr-par.scw.cloud.
898900
*/
899901
failoverHost?: string
900902
/**
@@ -1755,8 +1757,9 @@ export type UpdateBackendRequest = {
17551757
*/
17561758
proxyProtocol?: ProxyProtocol
17571759
/**
1758-
* Scaleway S3 bucket website to be served as failover if all backend servers
1759-
* are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
1760+
* Scaleway Object Storage bucket website to be served as failover if all
1761+
* backend servers are down, e.g.
1762+
* failover-website.s3-website.fr-par.scw.cloud.
17601763
*/
17611764
failoverHost?: string
17621765
/**
@@ -2119,8 +2122,9 @@ export type ZonedApiCreateBackendRequest = {
21192122
*/
21202123
proxyProtocol?: ProxyProtocol
21212124
/**
2122-
* Scaleway S3 bucket website to be served as failover if all backend servers
2123-
* are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
2125+
* Scaleway Object Storage bucket website to be served as failover if all
2126+
* backend servers are down, e.g.
2127+
* failover-website.s3-website.fr-par.scw.cloud.
21242128
*/
21252129
failoverHost?: string
21262130
/**
@@ -2778,8 +2782,9 @@ export type ZonedApiUpdateBackendRequest = {
27782782
*/
27792783
proxyProtocol?: ProxyProtocol
27802784
/**
2781-
* Scaleway S3 bucket website to be served as failover if all backend servers
2782-
* are down, e.g. failover-website.s3-website.fr-par.scw.cloud.
2785+
* Scaleway Object Storage bucket website to be served as failover if all
2786+
* backend servers are down, e.g.
2787+
* failover-website.s3-website.fr-par.scw.cloud.
27832788
*/
27842789
failoverHost?: string
27852790
/**

packages/clients/src/api/rdb/v1/types.gen.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -497,7 +497,7 @@ export interface ListInstanceLogsDetailsResponseInstanceLogDetail {
497497
}
498498

499499
export interface InstanceLog {
500-
/** Presigned S3 URL to download your log file. */
500+
/** Presigned Object Storage URL to download your log file. */
501501
downloadUrl?: string
502502
/** UUID of the Database Instance log. */
503503
id: string

0 commit comments

Comments
 (0)