Skip to content

docs(ipam): document expected format of requested IP #1258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 3, 2024
Merged

docs(ipam): document expected format of requested IP #1258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 5 additions & 20 deletions packages/clients/src/api/ipam/v1/api.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,7 @@ export class API extends ParentAPI {
),
headers: jsonContentHeaders,
method: 'POST',
path: `/ipam/v1/regions/${validatePathParam(
'region',
request.region ?? this.client.settings.defaultRegion,
)}/ips`,
path: `/ipam/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/ips`,
},
unmarshalIP,
)
Expand All @@ -72,10 +69,7 @@ export class API extends ParentAPI {
body: '{}',
headers: jsonContentHeaders,
method: 'DELETE',
path: `/ipam/v1/regions/${validatePathParam(
'region',
request.region ?? this.client.settings.defaultRegion,
)}/ips/${validatePathParam('ipId', request.ipId)}`,
path: `/ipam/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/ips/${validatePathParam('ipId', request.ipId)}`,
})

/**
Expand All @@ -88,10 +82,7 @@ export class API extends ParentAPI {
this.client.fetch<IP>(
{
method: 'GET',
path: `/ipam/v1/regions/${validatePathParam(
'region',
request.region ?? this.client.settings.defaultRegion,
)}/ips/${validatePathParam('ipId', request.ipId)}`,
path: `/ipam/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/ips/${validatePathParam('ipId', request.ipId)}`,
},
unmarshalIP,
)
Expand All @@ -110,10 +101,7 @@ export class API extends ParentAPI {
),
headers: jsonContentHeaders,
method: 'PATCH',
path: `/ipam/v1/regions/${validatePathParam(
'region',
request.region ?? this.client.settings.defaultRegion,
)}/ips/${validatePathParam('ipId', request.ipId)}`,
path: `/ipam/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/ips/${validatePathParam('ipId', request.ipId)}`,
},
unmarshalIP,
)
Expand All @@ -122,10 +110,7 @@ export class API extends ParentAPI {
this.client.fetch<ListIPsResponse>(
{
method: 'GET',
path: `/ipam/v1/regions/${validatePathParam(
'region',
request.region ?? this.client.settings.defaultRegion,
)}/ips`,
path: `/ipam/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/ips`,
urlParams: urlParams(
['attached', request.attached],
['is_ipv6', request.isIpv6],
Expand Down
5 changes: 3 additions & 2 deletions packages/clients/src/api/ipam/v1/types.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,8 +115,9 @@ export type BookIPRequest = {
/** Request an IPv6 instead of an IPv4. */
isIpv6: boolean
/**
* 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 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.
*/
address?: string
/** Tags for the IP. */
Expand Down