Back to bug 1310669
| Who | When | What | Removed | Added |
|---|---|---|---|---|
| Red Hat Bugzilla Rules Engine | 2016-02-22 13:24:23 UTC | Target Milestone | --- | ovirt-4.0.0 |
| Juan Hernández | 2016-02-22 13:26:52 UTC | Doc Text | Feature: Support versions 3 and 4 of the API. Reason: Stay compatible with software that uses version 3 of the API. Result: Version 4 of the engine supports versions 3 and 4 of the API. Version 3 of the API will be identical to the API currently provided by version 3.6 of the engine. Version 4 will be different, as described in the <<Backwards compatibility breaking changes in oVirt 4.0, below>>. Users of the API can select the version using the HTTP `Version` header. The value of the header should be the version number. For example, to retrieve the list of virtual machines requesting explicitly version 3 of the API: GET /ovirt-engine/api/vms HTTP/1.1 Version: 3 ... Alternatively, for users that can't modify their software to send the `Version` header, it is also possible to add the `/v3` prefix to the URL, as in most cases the URL will be a configuration parameter: GET /ovirt-engine/api/v3/vms HTTP/1.1 ... When neither the header nor the URL prefix are used the server will automatically select a version. The default is version `4`, but this can be changed using the `ENGINE_API_DEFAULT_VERSION` parameter: $ echo "ENGINE_API_DEFAULT_VERSION=3" > \ /etc/ovirt-engine/engine.conf.d/99-set-default-version.conf $ systemctl restart ovirt-engine NOTE: Take into account that changing this parameter affects all users of the engine that don't specify the version explicitly. The SDKs provided by the oVirt project have already been modified to send the correct `Version` header, so users don't need to do anything if they are using versions 3.6.3.0 or later. | |
| Doc Type | Bug Fix | Enhancement | ||
| Sandro Bonazzola | 2016-04-06 13:17:09 UTC | Keywords | Improvement | |
| CC | sbonazzo | |||
| Sandro Bonazzola | 2016-04-06 13:17:50 UTC | Keywords | Documentation | |
| Sandro Bonazzola | 2016-05-02 10:10:34 UTC | Target Milestone | ovirt-4.0.0-alpha | ovirt-4.0.0-beta |
| Yaniv Lavi | 2016-05-23 12:54:41 UTC | Target Milestone | ovirt-4.0.0-beta | ovirt-4.0.0-rc |
| Yaniv Lavi | 2016-06-29 12:05:00 UTC | Target Milestone | ovirt-4.0.0-rc | ovirt-4.0.1 |
| Yaniv Lavi | 2016-06-29 12:05:04 UTC | Flags | ovirt-4.0.0? | ovirt-4.0.z? |
| Yaniv Lavi | 2016-08-16 12:48:49 UTC | Target Milestone | ovirt-4.0.1 | ovirt-4.0.3 |
| Lucy Bopf | 2016-08-19 04:27:09 UTC | Status | NEW | CLOSED |
| CC | lbopf | |||
| Resolution | --- | CURRENTRELEASE | ||
| Doc Text | Feature: Support versions 3 and 4 of the API. Reason: Stay compatible with software that uses version 3 of the API. Result: Version 4 of the engine supports versions 3 and 4 of the API. Version 3 of the API will be identical to the API currently provided by version 3.6 of the engine. Version 4 will be different, as described in the <<Backwards compatibility breaking changes in oVirt 4.0, below>>. Users of the API can select the version using the HTTP `Version` header. The value of the header should be the version number. For example, to retrieve the list of virtual machines requesting explicitly version 3 of the API: GET /ovirt-engine/api/vms HTTP/1.1 Version: 3 ... Alternatively, for users that can't modify their software to send the `Version` header, it is also possible to add the `/v3` prefix to the URL, as in most cases the URL will be a configuration parameter: GET /ovirt-engine/api/v3/vms HTTP/1.1 ... When neither the header nor the URL prefix are used the server will automatically select a version. The default is version `4`, but this can be changed using the `ENGINE_API_DEFAULT_VERSION` parameter: $ echo "ENGINE_API_DEFAULT_VERSION=3" > \ /etc/ovirt-engine/engine.conf.d/99-set-default-version.conf $ systemctl restart ovirt-engine NOTE: Take into account that changing this parameter affects all users of the engine that don't specify the version explicitly. The SDKs provided by the oVirt project have already been modified to send the correct `Version` header, so users don't need to do anything if they are using versions 3.6.3.0 or later. | Red Hat Virtualization 4.0 supports versions 3 and 4 of the REST API, to allow compatibility with software that uses version 3 of the REST API. Version 3 of the REST API is identical to the API currently provided by version 3.6 of the Red Hat Enterprise Virtualization Manager. Version 4 includes some differences, which are described in https://github.com/oVirt/ovirt-engine/tree/master/backend/manager/modules/restapi#2-backwards-compatibility-breaking-changes-in-version-3-of-the-api. The API version can be selected using the HTTP 'Version' header or the '/v3' prefix in the URL. When neither the header nor the URL prefix are used the server automatically selects a version. The default is version '4', but this can be changed using the 'ENGINE_API_DEFAULT_VERSION' parameter. Changing this parameter affects all users of the engine that don't specify the version explicitly. The SDKs included in Red Hat Virtualization have been modified to send the correct 'Version' header, so you do not need to do anything if you are using version 3.6.3.0 or later. | ||
| Last Closed | 2016-08-19 00:27:09 UTC |
Back to bug 1310669