Skip to content

Commit dbd26c0

Browse files
diogomdoAutomated
andauthored
docs: migrate to hybrid RST/Markdown documentation (#79)
Implements a pragmatic hybrid documentation approach: simple content in Markdown, API docs remain in RST. Also removed: `recommonmark`, `sphinx-markdown-parser` which are deprecated and replaced by maintained `myst-parser>=2.0.0` and setup accordingly --------- Co-authored-by: Automated <actions@users.noreply.github.com>
1 parent 477d12b commit dbd26c0

5 files changed

Lines changed: 236 additions & 278 deletions

File tree

docs/changes.md

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,205 @@
1+
# Changelog
2+
3+
## 0.16.1 (2026-01-22)
4+
5+
**Fixes**
6+
7+
* Partner API: Ensure organization responses match ``organization-output`` contract.
8+
Responses now only include documented fields (``id``, ``status``, ``billing-address``,
9+
``client-id``). Access organization name via ``billing-address.name``.
10+
11+
* GitHub Actions: Add automatic sync of Partner API OpenAPI spec (``partner-api.json``).
12+
13+
## 0.16.0 (2025-11-27)
14+
15+
**BREAKING CHANGES**
16+
17+
* Partner API: Update to ISO 20022 structured billing addresses. Organization
18+
creation now requires `display-name` and nested `billing-address` object
19+
instead of flat address fields. See [PR](https://github.com/exoscale/python-exoscale/pull/76) for migration guide.
20+
21+
## 0.15.0 (2025-10-28)
22+
23+
* Add Partner API client for distributor operations
24+
* Partner API client follows same patterns as V2 API
25+
* Automatic hourly updates of Partner API OpenAPI spec
26+
27+
## 0.14.0 (2025-08-28)
28+
29+
* Handle multiple response codes per OpenAPI operation.
30+
31+
## 0.13.0 (2025-08-11)
32+
33+
* Support hr-zag-1 zone
34+
* Remove DBaaS service Redis (replaced by Valkey)
35+
36+
## 0.12.0 (2025-06-04)
37+
38+
* Internals: abstract client generation logic into a separate
39+
`exoscale.api.generator` namespace.
40+
* API changes and additions:
41+
42+
* SKS: Rotate CCM credentials
43+
* Instance: TMP and Secure Boot support
44+
* DBaaS:
45+
46+
* Kafka: cluster networking options
47+
* New zone option: `hr-zag-1`
48+
49+
## 0.11.0 (2025-04-24)
50+
51+
* Bump python version requirement to 3.8 due to the use of the walrus
52+
operator.
53+
* Add `Client.wait(operation_id)` to poll for the result of an asynchronous
54+
API operation.
55+
56+
## 0.10.0 (2024-05-29)
57+
58+
* Introduce exception classes that gets raised when the API responds with 4xx
59+
or 5xx HTTP statuses.
60+
61+
## 0.9.1 (2024-04-29)
62+
63+
`exoscale.api.v2.Client` improvements:
64+
65+
* Client initialization accepts two signatures: `Client(key, secret, zone)` for
66+
typical use and `Client(key, secret, url)` when needing to target another
67+
endpoint than the public endpoint template.
68+
* Drop support for Python 3.7, add Python 3.12 to the testing matrix.
69+
* Fix operations with multiple path parameters ([@thomas-chauvet](https://github.com/exoscale/python-exoscale/pull/57))
70+
* API changes and additions:
71+
72+
* DBaaS:
73+
74+
* integrations settings
75+
* Split secrets over to separate endpoints
76+
* Add zone to service details
77+
* DNS record types cleanup
78+
* Instance password reset operation
79+
* Provide `at-vie-2` in the zones choices
80+
* Block Storage operations and CSI addon
81+
* Audit-trail format adjustments
82+
* Add MAC address to private network attachments
83+
84+
## 0.8.0 (2023-05-11)
85+
86+
* Add `exoscale.api.v2.Client`: a low-level API client targeting the Exoscale
87+
V2 API.
88+
89+
## 0.7.1 (2021-10-18)
90+
91+
**Fixes**
92+
93+
* compute: fix `instance_private_networks` arg check in `create_instance_pool()` method
94+
95+
## 0.7.0 (2021-05-11)
96+
97+
**Features**
98+
99+
* compute: add support for Deploy Targets resources
100+
* compute: Instance Pools now support Elastic IP attachment, Instance Prefix and
101+
Deploy Targets
102+
* compute: the `InstancePool.update()` method now supports updating Anti-Affinity
103+
Groups, IPv6 enabling, Security Groups, Private Networks and SSH Key.
104+
* compute: new `InstancePool.evict()` method
105+
106+
**Changes**
107+
108+
* compute: the `get_instance_pool()` method now accepts either of `name`/`id`
109+
parameters
110+
* compute: the `InstancePool.delete()` method `wait`/`max_poll` parameters have
111+
been removed
112+
113+
## 0.6.0 (2021-04-21)
114+
115+
**Features**
116+
117+
* compute: the `SecurityGroup.update()` now updates the Compute instance Security
118+
Groups membership live without requiring to stop the instance
119+
* compute: add `Instance.user_data` property
120+
* compute: add `InstanceTemplate.boot_mode` attribute
121+
* dns: `create_dns_record()` now returns the created record
122+
123+
**Fixes**
124+
125+
* compute: don't crash when an Instance Template doesn't have details metadata
126+
127+
## 0.5.2 (2021-04-13)
128+
129+
**Fixes**
130+
131+
* compute: add missing `bootmode` parameter to `register_instance_template()` (#32)
132+
133+
## 0.5.1 (2021-03-16)
134+
135+
**Fixes**
136+
137+
* Exclude tests from Python packaging
138+
139+
## 0.5.0 (2021-03-15)
140+
141+
**Features**
142+
143+
* compute: add Anti-Affinity Groups support to Instance Pools (#27)
144+
145+
**Fixes**
146+
147+
* Rely on pathlib for home lookup (#29)
148+
* compute: don't crash when listing instances generated from templates (#28)
149+
150+
## 0.4.0 (2020-12-07)
151+
152+
**Features**
153+
154+
* compute: add support for Network Load Balancers
155+
* compute: add support for Elastic IP HTTPS health checking
156+
* compute: add support for snapshot exporting
157+
158+
**Changes**
159+
160+
* compute: `get_instance_pool()` arguments order
161+
162+
## 0.3.0 (2020-01-22)
163+
164+
**New**
165+
166+
* Add support for IAM (`iam` submodule)
167+
168+
**Features**
169+
170+
* Allow HTTP session retry policy to be user configurable
171+
* compute: add support for Instance Pools
172+
* compute: add support for Elastic IP descriptions
173+
* compute: add Instance `creation_date` attribute
174+
175+
**Fixes**
176+
177+
* storage: fix failing integration tests
178+
* storage: honor global client settings
179+
180+
## 0.2.0 (2019-10-09)
181+
182+
**Features**
183+
184+
* storage: add Bucket/BucketFile `url` attribute
185+
186+
**Fixes**
187+
188+
* compute: fix unhandled exception in `get_*` functions
189+
190+
**Changes**
191+
192+
* compute: `create_instance()` function *root_disk_size* parameter has been renamed
193+
to *volume_size*
194+
* compute: `get_elastic_ip()` function now requires a *zone* parameter
195+
* compute: `get_instance_template()` function now requires a *zone* parameter
196+
* compute: `get_instance()` function now requires a *zone* parameter
197+
* compute: `get_private_network()` function now requires a *zone* parameter
198+
* compute: `list_elastic_ips()` function now requires a *zone* parameter
199+
* compute: `list_instance_templates()` function now requires a *zone* parameter
200+
* compute: `list_instances()` function now requires a *zone* parameter
201+
* compute: `list_private_networks()` function now requires a *zone* parameter
202+
203+
## 0.1.1 (2019-09-12)
204+
205+
* Initial release

0 commit comments

Comments
 (0)