Bug 1310669 - Document support for multiple versions of the API
Summary: Document support for multiple versions of the API
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: ovirt-engine
Classification: oVirt
Component: Documentation
Version: 3.6.3.3
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified vote
Target Milestone: ovirt-4.0.3
: ---
Assignee: bugs@ovirt.org
QA Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-02-22 13:24 UTC by Juan Hernández
Modified: 2016-08-19 04:27 UTC (History)
4 users (show)

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.
Clone Of:
Environment:
Last Closed: 2016-08-19 04:27:09 UTC
oVirt Team: Docs
ylavi: ovirt-4.0.z?
juan.hernandez: planning_ack?
juan.hernandez: devel_ack+
juan.hernandez: testing_ack?

Attachments (Terms of Use)
Add an attachment (proposed patch, testcase, etc.)

Description Juan Hernández 2016-02-22 13:24:21 UTC 
Version 4 of the engine will support versions 3 and 4 of the API, as described here:

  https://github.com/oVirt/ovirt-engine/tree/master/backend/manager/modules/restapi#11-support-for-versions-3-and-4-of-the-api

This needs to be documented, and included in the release notes.
Comment 1 Sandro Bonazzola 2016-05-02 10:10:34 UTC 
Moving from 4.0 alpha to 4.0 beta since 4.0 alpha has been already released and bug is not ON_QA.
Comment 2 Lucy Bopf 2016-08-19 04:27:09 UTC 
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
Note You need to log in before you can comment on or make changes to this bug.