@@ -22,81 +22,81 @@ export type ServerTypeStock =
2222 | 'low_stock'
2323 | 'high_stock'
2424
25- /** List os response */
25+ /** List os response. */
2626export interface ListOSResponse {
27- /** Total number of os */
27+ /** Total number of os. */
2828 totalCount : number
29- /** List of OS */
29+ /** List of OS. */
3030 os : OS [ ]
3131}
3232
33- /** List server types response */
33+ /** List server types response. */
3434export interface ListServerTypesResponse {
35- /** The available server types */
35+ /** The available server types. */
3636 serverTypes : ServerType [ ]
3737}
3838
39- /** List servers response */
39+ /** List servers response. */
4040export interface ListServersResponse {
41- /** The total number of servers */
41+ /** The total number of servers. */
4242 totalCount : number
43- /** The paginated returned servers */
43+ /** The paginated returned servers. */
4444 servers : Server [ ]
4545}
4646
47- /** Os */
47+ /** Os. */
4848export interface OS {
49- /** The OS unique ID */
49+ /** The OS unique ID. */
5050 id : string
51- /** The OS name */
51+ /** The OS name. */
5252 name : string
53- /** The OS name as it should be displayed */
53+ /** The OS name as it should be displayed. */
5454 label : string
55- /** URL of the image */
55+ /** URL of the image. */
5656 imageUrl : string
57- /** List of compatible server types */
57+ /** List of compatible server types. */
5858 compatibleServerTypes : string [ ]
5959}
6060
61- /** Server */
61+ /** Server. */
6262export interface Server {
63- /** UUID of the server */
63+ /** UUID of the server. */
6464 id : string
65- /** Type of the server */
65+ /** Type of the server. */
6666 type : string
67- /** Name of the server */
67+ /** Name of the server. */
6868 name : string
69- /** Project this server is associated with */
69+ /** Project this server is associated with. */
7070 projectId : string
71- /** Organization this server is associated with */
71+ /** Organization this server is associated with. */
7272 organizationId : string
73- /** IPv4 address of the server */
73+ /** IPv4 address of the server. */
7474 ip : string
75- /** URL of the VNC */
75+ /** URL of the VNC. */
7676 vncUrl : string
77- /** Current status of the server */
77+ /** Current status of the server. */
7878 status : ServerStatus
79- /** The date at which the server was created */
79+ /** The date at which the server was created. */
8080 createdAt ?: Date
81- /** The date at which the server was last updated */
81+ /** The date at which the server was last updated. */
8282 updatedAt ?: Date
83- /** The date at which the server was last deleted */
83+ /** The date at which the server was last deleted. */
8484 deletableAt ?: Date
85- /** The zone of the server */
85+ /** The zone of the server. */
8686 zone : Zone
8787}
8888
89- /** Server type */
89+ /** Server type. */
9090export interface ServerType {
91- /** CPU description */
91+ /** CPU description. */
9292 cpu ?: ServerTypeCPU
93- /** Size of the local disk of the server */
93+ /** Size of the local disk of the server. */
9494 disk ?: ServerTypeDisk
95- /** Name of the type */
95+ /** Name of the type. */
9696 name : string
97- /** Size of memory available */
97+ /** Size of memory available. */
9898 memory ?: ServerTypeMemory
99- /** Current stock */
99+ /** Current stock. */
100100 stock : ServerTypeStock
101101 /** Minimum duration of the lease in seconds (example. 3.4s). */
102102 minimumLeaseDuration ?: string
@@ -118,105 +118,105 @@ export interface ServerTypeMemory {
118118}
119119
120120export type ListServerTypesRequest = {
121- /** Zone to target. If none is passed will use default zone from the config */
121+ /** Zone to target. If none is passed will use default zone from the config. */
122122 zone ?: Zone
123123}
124124
125125export type GetServerTypeRequest = {
126- /** Zone to target. If none is passed will use default zone from the config */
126+ /** Zone to target. If none is passed will use default zone from the config. */
127127 zone ?: Zone
128- /** Server type identifier */
128+ /** Server type identifier. */
129129 serverType : string
130130}
131131
132132export type CreateServerRequest = {
133- /** Zone to target. If none is passed will use default zone from the config */
133+ /** Zone to target. If none is passed will use default zone from the config. */
134134 zone ?: Zone
135- /** Create a server with this given name */
135+ /** Create a server with this given name. */
136136 name ?: string
137- /** Create a server in the given project ID */
137+ /** Create a server in the given project ID. */
138138 projectId ?: string
139- /** Create a server of the given type */
139+ /** Create a server of the given type. */
140140 type : string
141141}
142142
143143export type ListServersRequest = {
144- /** Zone to target. If none is passed will use default zone from the config */
144+ /** Zone to target. If none is passed will use default zone from the config. */
145145 zone ?: Zone
146- /** The sort order of the returned servers */
146+ /** The sort order of the returned servers. */
147147 orderBy ?: ListServersRequestOrderBy
148- /** List only servers of this project ID */
148+ /** List only servers of this project ID. */
149149 projectId ?: string
150- /** List only servers of this organization ID */
150+ /** List only servers of this organization ID. */
151151 organizationId ?: string
152- /** A positive integer to choose the page to return */
152+ /** A positive integer to choose the page to return. */
153153 page ?: number
154154 /**
155155 * A positive integer lower or equal to 100 to select the number of items to
156- * return
156+ * return.
157157 */
158158 pageSize ?: number
159159}
160160
161161export type ListOSRequest = {
162- /** Zone to target. If none is passed will use default zone from the config */
162+ /** Zone to target. If none is passed will use default zone from the config. */
163163 zone ?: Zone
164- /** A positive integer to choose the page to return */
164+ /** A positive integer to choose the page to return. */
165165 page ?: number
166166 /**
167167 * A positive integer lower or equal to 100 to select the number of items to
168- * return
168+ * return.
169169 */
170170 pageSize ?: number
171- /** List of compatible server type */
171+ /** List of compatible server type. */
172172 serverType ?: string
173173 /**
174174 * Filter os by name (for eg. "11.1" will return "11.1.2" and "11.1" but not
175- * "12")
175+ * "12").
176176 */
177177 name ?: string
178178}
179179
180180export type GetOSRequest = {
181- /** Zone to target. If none is passed will use default zone from the config */
181+ /** Zone to target. If none is passed will use default zone from the config. */
182182 zone ?: Zone
183- /** UUID of the OS you want to get */
183+ /** UUID of the OS you want to get. */
184184 osId : string
185185}
186186
187187export type GetServerRequest = {
188- /** Zone to target. If none is passed will use default zone from the config */
188+ /** Zone to target. If none is passed will use default zone from the config. */
189189 zone ?: Zone
190- /** UUID of the server you want to get */
190+ /** UUID of the server you want to get. */
191191 serverId : string
192192}
193193
194194export type UpdateServerRequest = {
195- /** Zone to target. If none is passed will use default zone from the config */
195+ /** Zone to target. If none is passed will use default zone from the config. */
196196 zone ?: Zone
197- /** UUID of the server you want to update */
197+ /** UUID of the server you want to update. */
198198 serverId : string
199- /** Updated name for your server */
199+ /** Updated name for your server. */
200200 name : string
201201}
202202
203203export type DeleteServerRequest = {
204- /** Zone to target. If none is passed will use default zone from the config */
204+ /** Zone to target. If none is passed will use default zone from the config. */
205205 zone ?: Zone
206- /** UUID of the server you want to delete */
206+ /** UUID of the server you want to delete. */
207207 serverId : string
208208}
209209
210210export type RebootServerRequest = {
211- /** Zone to target. If none is passed will use default zone from the config */
211+ /** Zone to target. If none is passed will use default zone from the config. */
212212 zone ?: Zone
213- /** UUID of the server you want to reboot */
213+ /** UUID of the server you want to reboot. */
214214 serverId : string
215215}
216216
217217export type ReinstallServerRequest = {
218- /** Zone to target. If none is passed will use default zone from the config */
218+ /** Zone to target. If none is passed will use default zone from the config. */
219219 zone ?: Zone
220- /** UUID of the server you want to reinstall */
220+ /** UUID of the server you want to reinstall. */
221221 serverId : string
222222}
0 commit comments