From eb0ade0e0766480fe18fff8c6a1ae018d47f631f Mon Sep 17 00:00:00 2001 From: scaleway-bot Date: Mon, 11 Jul 2022 12:50:42 +0000 Subject: [PATCH] feat: update generated APIs --- .../clients/src/api/baremetal/v1/types.gen.ts | 1 + .../clients/src/api/instance/v1/api.utils.ts | 3 +- .../clients/src/api/instance/v1/types.gen.ts | 14 ++--- .../src/api/instance/v1/types.utils.ts | 8 +-- packages/clients/src/api/iot/v1/types.gen.ts | 10 ++++ packages/clients/src/api/k8s/v1/types.gen.ts | 6 +- packages/clients/src/api/lb/v1/types.gen.ts | 58 ++++++++++++++++++- .../src/api/marketplace/v1/types.gen.ts | 4 +- .../src/api/redis/v1alpha1/types.gen.ts | 2 + 9 files changed, 87 insertions(+), 19 deletions(-) diff --git a/packages/clients/src/api/baremetal/v1/types.gen.ts b/packages/clients/src/api/baremetal/v1/types.gen.ts index 5f11bdc51..cc3a3da56 100644 --- a/packages/clients/src/api/baremetal/v1/types.gen.ts +++ b/packages/clients/src/api/baremetal/v1/types.gen.ts @@ -83,6 +83,7 @@ export interface CPU { coreCount: number /** Number of threads of the CPU */ threadCount: number + /** Frequency of the CPU in MHz */ frequency: number } diff --git a/packages/clients/src/api/instance/v1/api.utils.ts b/packages/clients/src/api/instance/v1/api.utils.ts index 6f4df8d42..9d0d5503b 100644 --- a/packages/clients/src/api/instance/v1/api.utils.ts +++ b/packages/clients/src/api/instance/v1/api.utils.ts @@ -339,7 +339,8 @@ export class InstanceV1UtilsAPI extends InstanceV1GenAPI { this._createServer(request) /** - * Starts an action and wait for the server to be in the correct "terminal state" expected by this action. + * Starts an action and wait for the server to be in the correct "terminal + * state" expected by this action. * * @param request - The request {@link ServerActionRequest} * @returns A Promise of Server diff --git a/packages/clients/src/api/instance/v1/types.gen.ts b/packages/clients/src/api/instance/v1/types.gen.ts index 0d33f1326..d9c6f8d20 100644 --- a/packages/clients/src/api/instance/v1/types.gen.ts +++ b/packages/clients/src/api/instance/v1/types.gen.ts @@ -1433,21 +1433,21 @@ export type UpdatePlacementGroupServersRequest = { export type ListIpsRequest = { /** Zone to target. If none is passed will use default zone from the config */ zone?: Zone + /** The project ID the IPs are reserved in */ + project?: string /** The organization ID the IPs are reserved in */ organization?: string + /** + * Filter IPs with these exact tags (to filter with several tags, use commas + * to separate them) + */ + tags?: Array /** Filter on the IP address (Works as a LIKE operation on the IP address) */ name?: string /** A positive integer lower or equal to 100 to select the number of items to return */ perPage?: number /** A positive integer to choose the page to return */ page?: number - /** The project ID the IPs are reserved in */ - project?: string - /** - * Filter IPs with these exact tags (to filter with several tags, use commas - * to separate them) - */ - tags?: Array } export type CreateIpRequest = { diff --git a/packages/clients/src/api/instance/v1/types.utils.ts b/packages/clients/src/api/instance/v1/types.utils.ts index fea623367..431a85004 100644 --- a/packages/clients/src/api/instance/v1/types.utils.ts +++ b/packages/clients/src/api/instance/v1/types.utils.ts @@ -54,13 +54,13 @@ export type UpdateSecurityGroupRuleRequest = { ipRange?: string position?: number /** - * If set to 0, DestPortFrom will be removed. - * See SecurityGroupRule.DestPortFrom for more information + * If set to 0, DestPortFrom will be removed. See + * SecurityGroupRule.DestPortFrom for more information */ destPortFrom?: number /** - * If set to 0, DestPortTo will be removed. - * See SecurityGroupRule.DestPortTo for more information + * If set to 0, DestPortTo will be removed. See SecurityGroupRule.DestPortTo + * for more information */ destPortTo?: number } diff --git a/packages/clients/src/api/iot/v1/types.gen.ts b/packages/clients/src/api/iot/v1/types.gen.ts index eb092ff2d..6d8d2002a 100644 --- a/packages/clients/src/api/iot/v1/types.gen.ts +++ b/packages/clients/src/api/iot/v1/types.gen.ts @@ -167,8 +167,18 @@ export interface DeviceMessageFilters { subscribe?: DeviceMessageFiltersRule } +/** Device. message filters. rule */ export interface DeviceMessageFiltersRule { + /** + * If accept, the set will accept all topics in the topics list, but no other. + * If reject, the set will deny all topics in the topics list, but all others + * will be allowed. + */ policy: DeviceMessageFiltersRulePolicy + /** + * List of topics to accept or reject. It must be valid MQTT topics and up to + * 65535 characters + */ topics?: Array } diff --git a/packages/clients/src/api/k8s/v1/types.gen.ts b/packages/clients/src/api/k8s/v1/types.gen.ts index 087c4c2d0..8837f5ae7 100644 --- a/packages/clients/src/api/k8s/v1/types.gen.ts +++ b/packages/clients/src/api/k8s/v1/types.gen.ts @@ -722,7 +722,7 @@ export type CreateClusterRequest = { */ autoscalerConfig?: CreateClusterRequestAutoscalerConfig /** - * This configuratiom enables to set a speicific 2-hour time window in which + * This configuration enables to set a specific 2-hour time window in which * the cluster can be automatically updated to the latest patch version in the * current minor one. */ @@ -774,8 +774,8 @@ export type UpdateClusterRequest = { /** @deprecated The new Ingress Controller for the cluster */ ingress?: Ingress /** - * The new auo upgrade configuration of the cluster. Note that all the fields - * needs to be set. + * The new auto upgrade configuration of the cluster. Note that all fields + * need to be set. */ autoUpgrade?: UpdateClusterRequestAutoUpgrade /** List of feature gates to enable */ diff --git a/packages/clients/src/api/lb/v1/types.gen.ts b/packages/clients/src/api/lb/v1/types.gen.ts index 945e5b1ae..b6e97878f 100644 --- a/packages/clients/src/api/lb/v1/types.gen.ts +++ b/packages/clients/src/api/lb/v1/types.gen.ts @@ -875,20 +875,47 @@ export type GetBackendRequest = { export type UpdateBackendRequest = { /** Region to target. If none is passed will use default region from the config */ region?: Region + /** Backend ID to update */ backendId: string + /** Resource name */ name: string + /** Backend protocol. TCP or HTTP */ forwardProtocol: Protocol + /** User sessions will be forwarded to this port of backend servers */ forwardPort: number + /** Load balancing algorithm */ forwardPortAlgorithm: ForwardPortAlgorithm + /** Enable cookie-based session persistence */ stickySessions: StickySessionsType + /** Cookie name for for sticky sessions */ stickySessionsCookieName: string - /** @deprecated */ + /** @deprecated Deprecated in favor of proxy_protocol field! */ sendProxyV2?: boolean + /** Maximum server connection inactivity time */ timeoutServer?: string + /** Maximum initial server connection establishment time */ timeoutConnect?: string + /** Maximum tunnel inactivity time */ timeoutTunnel?: string + /** Modify what occurs when a backend server is marked down */ onMarkedDownAction: OnMarkedDownAction + /** + * The PROXY protocol informs the other end about the incoming connection, so + * that it can know the client's address or the public address it accessed to, + * whatever the upper layer protocol is. + * + * `proxy_protocol_none` Disable proxy protocol. `proxy_protocol_v1` Version + * one (text format). `proxy_protocol_v2` Version two (binary format). + * `proxy_protocol_v2_ssl` Version two with SSL connection. + * `proxy_protocol_v2_ssl_cn` Version two with SSL connection and common name + * information. + */ proxyProtocol: ProxyProtocol + /** + * Only the host part of the Scaleway S3 bucket website is expected. Example: + * `failover-website.s3-website.fr-par.scw.cloud` if your bucket website URL + * is `https://failover-website.s3-website.fr-par.scw.cloud/`. + */ failoverHost?: string } @@ -1642,20 +1669,47 @@ export type ZonedApiGetBackendRequest = { export type ZonedApiUpdateBackendRequest = { /** Zone to target. If none is passed will use default zone from the config */ zone?: Zone + /** Backend ID to update */ backendId: string + /** Resource name */ name: string + /** Backend protocol. TCP or HTTP */ forwardProtocol: Protocol + /** User sessions will be forwarded to this port of backend servers */ forwardPort: number + /** Load balancing algorithm */ forwardPortAlgorithm: ForwardPortAlgorithm + /** Enable cookie-based session persistence */ stickySessions: StickySessionsType + /** Cookie name for for sticky sessions */ stickySessionsCookieName: string - /** @deprecated */ + /** @deprecated Deprecated in favor of proxy_protocol field! */ sendProxyV2?: boolean + /** Maximum server connection inactivity time */ timeoutServer?: string + /** Maximum initial server connection establishment time */ timeoutConnect?: string + /** Maximum tunnel inactivity time */ timeoutTunnel?: string + /** Modify what occurs when a backend server is marked down */ onMarkedDownAction: OnMarkedDownAction + /** + * The PROXY protocol informs the other end about the incoming connection, so + * that it can know the client's address or the public address it accessed to, + * whatever the upper layer protocol is. + * + * `proxy_protocol_none` Disable proxy protocol. `proxy_protocol_v1` Version + * one (text format). `proxy_protocol_v2` Version two (binary format). + * `proxy_protocol_v2_ssl` Version two with SSL connection. + * `proxy_protocol_v2_ssl_cn` Version two with SSL connection and common name + * information. + */ proxyProtocol: ProxyProtocol + /** + * Only the host part of the Scaleway S3 bucket website is expected. Example: + * `failover-website.s3-website.fr-par.scw.cloud` if your bucket website URL + * is `https://failover-website.s3-website.fr-par.scw.cloud/`. + */ failoverHost?: string } diff --git a/packages/clients/src/api/marketplace/v1/types.gen.ts b/packages/clients/src/api/marketplace/v1/types.gen.ts index f5a4e9226..df64bcd08 100644 --- a/packages/clients/src/api/marketplace/v1/types.gen.ts +++ b/packages/clients/src/api/marketplace/v1/types.gen.ts @@ -28,7 +28,7 @@ export interface Image { modificationDate?: Date /** Expiration date of this image */ validUntil?: Date - /** Label of this image */ + /** Typically an identifier for a distribution (ex. "ubuntu_focal"). */ label: string /** List of versions of this image */ versions: Array @@ -49,7 +49,7 @@ export interface ListVersionsResponse { /** Local image */ export interface LocalImage { - /** UUID of this local image */ + /** Version you will typically use to define an image in an API call. */ id: string /** List of all commercial types that are compatible with this local image */ compatibleCommercialTypes: Array diff --git a/packages/clients/src/api/redis/v1alpha1/types.gen.ts b/packages/clients/src/api/redis/v1alpha1/types.gen.ts index a576cf330..1d9bd7491 100644 --- a/packages/clients/src/api/redis/v1alpha1/types.gen.ts +++ b/packages/clients/src/api/redis/v1alpha1/types.gen.ts @@ -500,12 +500,14 @@ export type AddEndpointsRequest = { export type DeleteEndpointRequest = { /** Zone to target. If none is passed will use default zone from the config */ zone?: Zone + /** UUID of the endpoint you want to delete */ endpointId: string } export type GetEndpointRequest = { /** Zone to target. If none is passed will use default zone from the config */ zone?: Zone + /** UUID of the endpoint you want to get */ endpointId: string }