You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pages/account/api/apiv2/guide.en-gb.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -19,13 +19,14 @@ A new section of the OVHcloud APIs is available under the prefix **/v2** on [htt
19
19
This new branch will bring together new API routes, reworked in a new format, and become the main API branch for new feature developments of OVHcloud products.<br>
20
20
The **/1.0** branch will continue to exist in parallel to the **/v2** branch but will not contain the same functionality. As a customer, you can consume APIs from branch **/1.0** and **/v2** simultaneously in your programs, while retaining the same authentication and tools to call the API. To standardise the naming of our API branches, the **/1.0** branch is also available via the **/v1** alias.
21
21
22
-
The **/v2** branch introduces new principles of exposure and consumption (which differ from the **/v1** branch), the purpose of this guide is to introduce them.
22
+
The **/v2** branch introduces new principles of exposure and consumption (which differ from the **/v1** branch). The purpose of this guide is to introduce them.
23
23
24
24
## Principles
25
25
26
26
### Version management
27
27
28
28
The */v2* branch of the API uses a versioning system to manage its specifications. This means that each modification in the API routes (input parameters, expected return, ...) will be the subject of a new version.
29
+
29
30
These versions (which are different from the version contained in the API branch name) will contain two numbers that increment: major and minor versions. This makes it possible to distinguish minor changes from major/breaking changes in API schemes. Minor (non-breaking) changes increment the minor version while breaking changes increment the major version.
30
31
31
32
A summary of the changes (*changelog*) accompanies the publication of each new version to get a detailed view of the changes made.
@@ -34,7 +35,7 @@ The API *v2* branch is designed to expose several major versions in parallel. Th
34
35
35
36
As a customer, you will be responsible for choosing the version you use. You will need to specify which major version of the specification will be used with your account.
36
37
37
-
When a new major release is released, the previous major release will remain active for a specified period of time in the *changelog* to give you time to adapt your applications.
38
+
When a new major version is released, the previous major release will remain active for a specified period of time in the *changelog* to give you time to adapt your applications.
38
39
Before the availability period for the previous major version ends, you will need to ensure that your applications using the OVHcloud API are still compatible, and make the major version change in your Control Panel. If you do not do so, you will be automatically migrated to the latest major version at the end of your current major release availability period.
39
40
40
41
#### Select a specific major version of the API
@@ -134,9 +135,9 @@ The APIv2 exposes cursor pagination, in which cursors are passed in the query an
134
135
135
136
The headers used are:
136
137
137
-
-`X-Pagination-Size`: this optional header allows you to control the size of the returned pages.
138
-
-`X-Pagination-Cursor-Next`: header returned by the API that contains the value to use in the next query to retrieve the next page.
139
-
-`X-Pagination-Cursor`: the header to send in a query to retrieve the next page.
138
+
-`X-Pagination-Size`: This optional header allows you to control the size of the returned pages.
139
+
-`X-Pagination-Cursor-Next`: Header returned by the API that contains the value to use in the next query to retrieve the next page.
140
+
-`X-Pagination-Cursor`: The header to send in a query to retrieve the next page.
140
141
141
142
For example, the following call will return the first 5 items and the cursor to use to retrieve the next page:
142
143
@@ -168,4 +169,4 @@ Several libraries are available to use the OVHcloud APIs:
168
169
169
170
[Using Terraform with OVHcloud](pages/account/api/terraform-at-ovhcloud)
170
171
171
-
Join our community of users on [https://community.ovh.com/en/](https://community.ovh.com/en/).
172
+
Join our community of users on <https://community.ovh.com/en/>.
0 commit comments