Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions packages/clients/src/api/ipam/v1/api.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ export class API extends ParentAPI {
public static readonly LOCALITIES: Region[] = ['fr-par', 'nl-ams', 'pl-waw']

/**
* Book a new IP. Book a new IP from the specified source. Currently IPs can
* only be booked from a Private Network.
* Reserve a new IP. Reserve a new IP from the specified source. Currently IPs
* can only be reserved from a Private Network.
*
* @param request - The request {@link BookIPRequest}
* @returns A Promise of IP
Expand Down Expand Up @@ -173,7 +173,7 @@ export class API extends ParentAPI {
enrichForPagination('ips', this.pageOfListIPs, request)

/**
* Attach existing IP to custom resource. Attach an existing IP from a Private
* Attach IP to custom resource. Attach an existing reserved IP from a Private
* Network subnet to a custom, named resource via its MAC address. An example
* of a custom resource is a virtual machine hosted on an Elastic Metal
* server. Do not use this method for attaching IP addresses to standard
Expand All @@ -197,11 +197,11 @@ export class API extends ParentAPI {
)

/**
* Detach existing IP from a custom resource. Detach a private IP from a
* custom resource. An example of a custom resource is a virtual machine
* hosted on an Elastic Metal server. Do not use this method for attaching IP
* addresses to standard Scaleway resources (e.g. Instances, Load Balancers)
* as it will fail - see the relevant product API for an equivalent method.
* Detach IP from a custom resource. Detach a private IP from a custom
* resource. An example of a custom resource is a virtual machine hosted on an
* Elastic Metal server. Do not use this method for detaching IP addresses
* from standard Scaleway resources (e.g. Instances, Load Balancers) as it
* will fail - see the relevant product API for an equivalent method.
*
* @param request - The request {@link DetachIPRequest}
* @returns A Promise of IP
Expand All @@ -220,7 +220,7 @@ export class API extends ParentAPI {
)

/**
* Move existing IP to a custom resource. Move an existing private IP from one
* Move IP to a custom resource. Move an existing reserved private IP from one
* custom resource (e.g. a virtual machine hosted on an Elastic Metal server)
* to another custom resource. This will detach it from the first resource,
* and attach it to the second. Do not use this method for moving IP addresses
Expand Down
13 changes: 8 additions & 5 deletions packages/clients/src/api/ipam/v1/types.gen.ts
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,11 @@ export interface IP {
projectId: string
/** Defines whether the IP is an IPv6 (false = IPv4). */
isIpv6: boolean
/** Date the IP was booked. */
/** Date the IP was reserved. */
createdAt?: Date
/** Date the IP was last modified. */
updatedAt?: Date
/** Source pool where the IP was booked in. */
/** Source pool where the IP was reserved in. */
source?: Source
/** Resource which the IP is attached to. */
resource?: Resource
Expand Down Expand Up @@ -133,20 +133,23 @@ export type BookIPRequest = {
* Private Network's Project.
*/
projectId?: string
/** Source in which to book the IP. Not all sources are available for booking. */
/**
* Source in which to reserve the IP. Not all sources are available for
* reservation.
*/
source: Source
/** Request an IPv6 instead of an IPv4. */
isIpv6: boolean
/**
* The requested address should not include the subnet mask (/suffix). Note
* that only the Private Network source allows you to pick a specific IP. If
* the requested IP is already booked, then the call will fail.
* the requested IP is already reserved, then the call will fail.
*/
address?: string
/** Tags for the IP. */
tags?: string[]
/**
* Custom resource to attach to the IP being booked. An example of a custom
* Custom resource to attach to the IP being reserved. An example of a custom
* resource is a virtual machine hosted on an Elastic Metal server. Do not use
* this for attaching IP addresses to standard Scaleway resources, as it will
* fail - instead, see the relevant product API for an equivalent method.
Expand Down
Loading