Bug 1317129 - [Docs] [Java SDK] authentication via the sessionid is not documented for python/java SDK
Summary: [Docs] [Java SDK] authentication via the sessionid is not documented for pyth...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 3.6.3
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: ovirt-4.0.0-beta
: 4.0.0
Assignee: Andrew Dahms
QA Contact: Lucy Bopf
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-03-12 09:16 UTC by Roman Hodain
Modified: 2019-11-14 07:37 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-05-30 22:58:58 UTC
oVirt Team: Docs
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Roman Hodain 2016-03-12 09:16:37 UTC
Description of problem:
    The documentation does not contain instruction how to use the session id for the available SDKs. This is problematic as event java-docs does not contain some information.

Affected docs:
   Java SDK Guide - Using the Red Hat Enterprise Virtualization Java SDK 
   Python SDK Guide - Using the Red Hat Enterprise Virtualization Python SDK

Version-Release number of selected component (if applicable):
3.6

Additional notes:
For example java doc says that the Api constructor can be called in the following way:

    Api(java.lang.String url, java.lang.String sessionid) 

but it does not explain what is the format of the sessionid. This is confusing as one would do:

     sessionid='V7tybi14lt8GrzWoqlGobQnf'

but the right way is:

     sessionid='JSESSIONID=V7tybi14lt8GrzWoqlGobQnf...'

So the documentation should include a description of the session id usage and an example of usage.

Comment 1 Andrew Dahms 2016-05-09 05:32:10 UTC
Taking to work on in conjunction with BZ#1325323.

Comment 2 Yaniv Lavi 2016-05-09 10:56:36 UTC
oVirt 4.0 Alpha has been released, moving to oVirt 4.0 Beta target.

Comment 3 Andrew Dahms 2016-05-10 05:43:05 UTC
Moving to modified.

Tech review being requested in BZ#1325323 alongside the changes in that bug that also touch on the Java SDK.

Comment 4 Andrew Dahms 2016-05-20 01:59:34 UTC
Moving to ON_QA.

Assigning Lucy as the QA contact.

Lucy - would you be able to take a look at the changes for this bug?

See comment #4 in BZ#1325323 for the details.

Comment 5 Lucy Bopf 2016-05-23 03:53:55 UTC
Thanks, Andrew. I've reviewed the changes in bug 1325323, and everything looks good to me.

Moving to VERIFIED.


Note You need to log in before you can comment on or make changes to this bug.