Skip to content
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.

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

fix: initial pass on docs updates for correctness #154

Merged
merged 5 commits into from
Jul 15, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
1 change: 0 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,6 @@ cluster = {
),
'web2': Server(
plan='2xCPU-4GB',
memory_amount=1024,
hostname='web2.example.com',
zone='uk-lon1',
storage_devices=[
Expand Down
4 changes: 2 additions & 2 deletions docs/Firewall.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@

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

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

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

## List / Get
Expand Down
4 changes: 2 additions & 2 deletions docs/Server.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ manager.create_server( server )

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

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

## Update

Expand All @@ -82,7 +82,7 @@ Updateable attributes:
"nic_model", "title", "timezone", "video_model", "vnc", "vnc_password"
```

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

### Storages

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

If you haven't used UpCloud's API before, please see
[Getting Started With UpCloud’s API](https://www.upcloud.com/support/getting-started-with-upclouds-api/).
lu1a marked this conversation as resolved.
Show resolved Hide resolved

The documentation is divided into two parts. Usage describes the basic CRUD functionality for the object
representations of different UpCloud resources (servers, storages, networks etc). The CloudManager describes
the API for performing direct API calls.
Expand Down
1 change: 1 addition & 0 deletions upcloud_api/cloud_manager/server_mixin.py
Original file line number Diff line number Diff line change
Expand Up @@ -111,6 +111,7 @@ def create_server(self, server: Server) -> Server:
* Debian 10: 01000000-0000-4000-8000-000020050100
lu1a marked this conversation as resolved.
Show resolved Hide resolved
* Ubuntu 20.04: 01000000-0000-4000-8000-000030200200
* Windows 2019: 01000000-0000-4000-8000-000010070300

lu1a marked this conversation as resolved.
Show resolved Hide resolved
"""
if isinstance(server, Server):
body = server.prepare_post_body()
Expand Down
Loading