vmj / groovy-upcloud Goto Github PK

Space is not a valid char in token. https://tools.ietf.org/html/rfc7231#section-5.5.3

Let's use "groovy-upcloud/<version>" instead.

Server resource has a simple_backup property (String).

IpAddressApi::update(Resource,....) used to be PUT in API version 1.2 and below. In API version 1.3 it has changed to PATCH.

There are two new APIs:

• GET /1.3/account/billing_summary/YYYY-MM
• GET /1.3/account/billing_summary/YYYY-MM/detailed

See if they require one or two methods in UpCloudApi trait.

Also, check how they parse and if they conflict with any of the resources.

https://developers.upcloud.com/1.3/3-accounts/#get-monthly-billing-summary

https://developers.upcloud.com/1.3/3-accounts/#get-detailed-monthly-billing-summary

This is separate from #3 but the implied (new) Billing resource will be a mess.

This begs a question: should the method take a RestartServer resource as a parameter?

https://developers.upcloud.com/1.3/8-servers/#restart-server

There's a new Network resource, part of which is a new IpNetwork resource. One can list, create, modify, and delete these networks.

• https://developers.upcloud.com/1.3/13-networks/#list-all-networks
• https://developers.upcloud.com/1.3/13-networks/#list-networks-within-zone
• https://developers.upcloud.com/1.3/13-networks/#create-sdn-private-network
• https://developers.upcloud.com/1.3/13-networks/#get-network-details
• https://developers.upcloud.com/1.3/13-networks/#modify-network-details
• https://developers.upcloud.com/1.3/13-networks/#delete-network

When dealing with Server resources, there's a new list of Interface resources in the networking property.

• https://developers.upcloud.com/1.3/8-servers/#get-server-details
• https://developers.upcloud.com/1.3/8-servers/#create-server

These Interface resources can also be created after the server creation. The server must be stopped and the network must already exist.

• https://developers.upcloud.com/1.3/13-networks/#create-network-interface
• https://developers.upcloud.com/1.3/13-networks/#modify-network-interface
• https://developers.upcloud.com/1.3/13-networks/#delete-network-interface

The UpCloudApi::account response may have resource_limits and/or trial_resource_limits properties. These should be added to Account resource.

https://developers.upcloud.com/1.3/3-accounts/#get-account-information

• A new resource Host, which has (among other simple properties) a List<Stat> stats property
• A new method UpCloudApi::hosts that returns a list of List<Host> hosts resources
• A new API trait HostApi with the methods:
  • HostApi::load(...args)
  • HostApi::update(Resource, ...args) (only Host::description seems to be allowed here`)

Question: the properties of Host or Stat are not documented?

https://developers.upcloud.com/1.3/14-hosts/

https://developers.upcloud.com/1.3/5-zones/

Zones in the prices listing may have the following subresources that are not covered:

• ServerPlan_1xCPU_2GB
• ServerPlan_2xCPU_4GB
• ServerPlan_4xCPU_8GB
• ServerPlan_6xCPU_16GB
• ServerPlan_8xCPU_32GB
• ServerPlan_12xCPU_48GB
• ServerPlan_16xCPU_64GB
• ServerPlan_20xCPU_96GB
• ServerPlan_20xCPU_128GB
• NetworkPrivateVlan
• StorageTemplate

They each have the amount and price fields common to the plan resources.

Starting a server used to be an empty POST call. Now it takes a Server resource with host and/or avoidHost properties.

Both of those properties are optional. Does the API still accept empty POST body?

https://developers.upcloud.com/1.3/8-servers/#start-server

Restarting a server now takes an optional host property.This begs a question: should the method take a RestartServer resource as a parameter? And why not avoidHost, or does it?

https://developers.upcloud.com/1.3/8-servers/#restart-server

They replace the vnc* properties.

https://developers.upcloud.com/1.3/8-servers/#get-server-details

https://developers.upcloud.com/1.3/8-servers/#create-server

https://developers.upcloud.com/1.3/8-servers/#modify-server

• Listing accounts: https://developers.upcloud.com/1.3/3-accounts/#get-account-list
  • UpCloudApi.accounts(...): GET /1.3/account/list -> 200 OK
  • List<Account> response.accounts
  • Account is a new Resource
    • List<String> roles
    • String type
    • String username
• Get account details: https://developers.upcloud.com/1.3/3-accounts/#get-account-details
  • AccountApi (new API trait): HTTP and username
    • AccountApi.load(): GET /1.3/account/details/username (would "sub" instead of "details" work?)
    • Account response.account
      • A lot of simple (String) properties
      • Quite a few List<String> properties
      • Including type and username and roles from account listing
      • servers list adds a new property to Server resource: storage "yes" or "no"
      • servers list reuses uuid property
• Add subaccount: https://developers.upcloud.com/1.3/3-accounts/#add-subaccount
  • UpCloudApi.create(SubAccount, ...): POST /1.3/account/sub
    • NOTE: Takes SubAccount, not Account (they are very similar if not identical)
    • NOTE: POSTs it to /account/sub, not to /sub_account
• Modify subaccount: https://developers.upcloud.com/1.3/3-accounts/#modify-account-details
  • AccountApi.update(Account, ...): PUT /1.3/account/sub/username ("details" works too)
• Delete subaccount: https://developers.upcloud.com/1.3/3-accounts/#delete-subaccount
  • AccountApi.detele(...): DELETE /1.3/account/sub/username (would "details" work?)

These properties seem to be available in UpCloudApi::ipAddresses response, and IpAddressApi::load response.

https://developers.upcloud.com/1.3/10-ip-addresses/#list-ip-addresses

https://developers.upcloud.com/1.3/10-ip-addresses/#get-ip-address-details

The mac and floating properties can be sent in UpCloudApi::create(IpAddress,...) payload.

https://developers.upcloud.com/1.3/10-ip-addresses/#assign-ip-address

The mac can be sent in IpAddressApi::update(IpAddress,...) payload.

https://developers.upcloud.com/1.3/10-ip-addresses/#modify-ip-address

There's a new API

• GET /1.3/account/resource_billing_summary/RESOURCE_ID/YYYY-MM

where RESOURCE_ID can be a server or storage UUID or an IP address.

https://developers.upcloud.com/1.3/3-accounts/#get-monthly-resource-billing-summary

This issue is separate from #2 but the implied (new) Billing resource will be a mess.