Bug 1310669
| Summary: | Document support for multiple versions of the API | ||
|---|---|---|---|
| Product: | [oVirt] ovirt-engine | Reporter: | Juan Hernández <juan.hernandez> |
| Component: | Documentation | Assignee: | bugs <bugs> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | |
| Severity: | unspecified | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 3.6.3.3 | CC: | adahms, lbopf, sbonazzo, ylavi |
| Target Milestone: | ovirt-4.0.3 | Keywords: | Documentation, Improvement |
| Target Release: | --- | Flags: | ylavi:
ovirt-4.0.z?
juan.hernandez: planning_ack? juan.hernandez: devel_ack+ juan.hernandez: testing_ack? |
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Enhancement | |
| Doc Text: |
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.
|
Story Points: | --- |
| Clone Of: | Environment: | ||
| Last Closed: | 2016-08-19 04:27:09 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | Docs | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
|
Description
Juan Hernández
2016-02-22 13:24:21 UTC
Moving from 4.0 alpha to 4.0 beta since 4.0 alpha has been already released and bug is not ON_QA. The documentation has been updated to account for v3 and v4 REST API support in the following locations: REST API Guide: https://access.stage.redhat.com/documentation/en/red-hat-virtualization/4.0/single/rest-api-guide#Example_Access_API_Entry_Point Java SDK Guide: https://access.stage.redhat.com/documentation/en/red-hat-virtualization/4.0/single/java-sdk-guide#chap-Overview https://access.stage.redhat.com/documentation/en/red-hat-virtualization/4.0/single/java-sdk-guide#Connecting_to_the_Red_Hat_Enterprise_Virtualization_Manager_3 Python SDK Guide: https://access.stage.redhat.com/documentation/en/red-hat-virtualization/4.0/single/python-sdk-guide#chap-Overview https://access.stage.redhat.com/documentation/en/red-hat-virtualization/4.0/single/python-sdk-guide#Python_Quick_Start_Introduction |