Skip to content

feat(instance): deprecate use of NATed IP in instance api documentation #1410

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
Sep 10, 2024
Merged

feat(instance): deprecate use of NATed IP in instance api documentation #1410

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: 17 additions & 8 deletions packages/clients/src/api/instance/v1/types.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -407,8 +407,11 @@ export interface Server {
creationDate?: Date
/** True if a dynamic IPv4 is required. */
dynamicIpRequired: boolean
/** True to configure the instance so it uses the new routed IP mode. */
routedIpEnabled: boolean
/**
* @deprecated True to configure the instance so it uses the routed IP mode.
* Use of `routed_ip_enabled` as `False` is deprecated.
*/
routedIpEnabled?: boolean
/**
* @deprecated True if IPv6 is enabled (deprecated and always `False` when
* `routed_ip_enabled` is `True`).
Expand Down Expand Up @@ -865,7 +868,10 @@ export type CreateIpRequest = {
tags?: string[]
/** UUID of the Instance you want to attach the IP to. */
server?: string
/** IP type to reserve (either 'nat', 'routed_ipv4' or 'routed_ipv6'). */
/**
* IP type to reserve (either 'routed_ipv4' or 'routed_ipv6', use of 'nat' is
* deprecated).
*/
type?: IpType
}

Expand Down Expand Up @@ -1012,7 +1018,10 @@ export type CreateServerRequest = {
name?: string
/** Define if a dynamic IPv4 is required for the Instance. */
dynamicIpRequired?: boolean
/** If true, configure the Instance so it uses the new routed IP mode. */
/**
* @deprecated If true, configure the Instance so it uses the new routed IP
* mode.
*/
routedIpEnabled?: boolean
/** Define the Instance commercial type (i.e. GP1-S). */
commercialType: string
Expand Down Expand Up @@ -1459,8 +1468,8 @@ export type ListIpsRequest = {
/** A positive integer to choose the page to return. */
page?: number
/**
* Filter on the IP Mobility IP type (whose value should be either 'nat',
* 'routed_ipv4' or 'routed_ipv6').
* Filter on the IP Mobility IP type (whose value should be either
* 'routed_ipv4', 'routed_ipv6' or 'nat').
*/
type?: string
}
Expand Down Expand Up @@ -2035,8 +2044,8 @@ export type UpdateServerRequest = {
bootscript?: string
dynamicIpRequired?: boolean
/**
* True to configure the instance so it uses the new routed IP mode (once this
* is set to True you cannot set it back to False).
* @deprecated True to configure the instance so it uses the new routed IP
* mode (once this is set to True you cannot set it back to False).
*/
routedIpEnabled?: boolean
/** A list of reserved IP IDs to attach to the Instance. */
Expand Down
4 changes: 2 additions & 2 deletions packages/clients/src/api/instance/v1/types.private.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,8 +118,8 @@ export type SetServerRequest = {
/** True if a dynamic IPv4 is required. */
dynamicIpRequired: boolean
/**
* True to configure the instance so it uses the new routed IP mode (once this
* is set to True you cannot set it back to False).
* @deprecated True to configure the instance so it uses the new routed IP
* mode (once this is set to True you cannot set it back to False).
*/
routedIpEnabled?: boolean
/**
Expand Down