Skip to content

Commit 56f6096

Browse files
lewistorringtonlu1a
authored andcommitted
fix: initial pass on docs updates for correctness
1 parent 1067b40 commit 56f6096

File tree

5 files changed

+5
-8
lines changed

5 files changed

+5
-8
lines changed

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,6 @@ cluster = {
7878
),
7979
'web2': Server(
8080
plan='2xCPU-4GB',
81-
memory_amount=1024,
8281
hostname='web2.example.com',
8382
zone='uk-lon1',
8483
storage_devices=[

docs/Firewall.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
Firewall is configured with FirewallRule objects that are specific to each server.
66
Please note that a servers firewall rules are ignored if firewall is turned off
7-
(see [Server](/server) and [API documentation](https://www.upcloud.com/api/7-servers/#modify-server)).
7+
(see [Server](/server) and [API documentation](https://developers.upcloud.com/1.3/8-servers/#modify-server)).
88

99
If a server is removed, its firewall and thus its firewall rules are removed too.
1010

11-
Please refer to the [API documentation](https://www.upcloud.com/api/10-firewall/#create-firewall-rule)
11+
Please refer to the [API documentation](https://developers.upcloud.com/1.3/11-firewall/#create-firewall-rule)
1212
for more info on the attributes of FirewallRule.
1313

1414
## List / Get

docs/Server.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ manager.create_server( server )
5757

5858
Currently available operating system templates can be retrieved with 'manager.get_templates()'. More information on this method can be found in storage_mixin documentation.
5959

60-
Please refer to the [API documentation](https://www.upcloud.com/static/downloads/upcloud-apidoc-1.1.1.pdf) for the allowed Server attributes.
60+
Please refer to the [API documentation](https://developers.upcloud.com/1.3/8-servers/#modify-server) for the allowed Server attributes.
6161

6262
## Update
6363

@@ -82,7 +82,7 @@ Updateable attributes:
8282
"nic_model", "title", "timezone", "video_model", "vnc", "vnc_password"
8383
```
8484

85-
Please refer to the [API documentation](https://www.upcloud.com/static/downloads/upcloud-apidoc-1.1.1.pdf) for the allowed values.
85+
Please refer to the [API documentation](https://developers.upcloud.com/1.3/8-servers/#modify-server) for the allowed values.
8686

8787
### Storages
8888

docs/index.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@ This documentation includes many code examples for administrating resources on t
88
In some cases it can help to be familiar with [UpCloud's API v1.3 documentation](https://www.upcloud.com/api/).
99
The code itself also has commentary & examples and is structured similarly to this documentation.
1010

11-
If you haven't used UpCloud's API before, please see
12-
[Getting Started With UpCloud’s API](https://www.upcloud.com/support/getting-started-with-upclouds-api/).
13-
1411
The documentation is divided into two parts. Usage describes the basic CRUD functionality for the object
1512
representations of different UpCloud resources (servers, storages, networks etc). The CloudManager describes
1613
the API for performing direct API calls.

upcloud_api/cloud_manager/server_mixin.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ def create_server(self, server: Server) -> Server:
111111
* Debian 10: 01000000-0000-4000-8000-000020050100
112112
* Ubuntu 20.04: 01000000-0000-4000-8000-000030200200
113113
* Windows 2019: 01000000-0000-4000-8000-000010070300
114+
114115
"""
115116
if isinstance(server, Server):
116117
body = server.prepare_post_body()

0 commit comments

Comments
 (0)