Bug 1317129
| Summary: | [Docs] [Java SDK] authentication via the sessionid is not documented for python/java SDK | ||
|---|---|---|---|
| Product: | Red Hat Enterprise Virtualization Manager | Reporter: | Roman Hodain <rhodain> |
| Component: | Documentation | Assignee: | Andrew Dahms <adahms> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Lucy Bopf <lbopf> |
| Severity: | medium | Docs Contact: | |
| Priority: | medium | ||
| Version: | 3.6.3 | CC: | adahms, gklein, lbopf, lsurette, rbalakri, srevivo |
| Target Milestone: | ovirt-4.0.0-beta | ||
| Target Release: | 4.0.0 | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | Bug Fix | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2016-05-30 22:58:58 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: | |||
Taking to work on in conjunction with BZ#1325323. oVirt 4.0 Alpha has been released, moving to oVirt 4.0 Beta target. Moving to modified. Tech review being requested in BZ#1325323 alongside the changes in that bug that also touch on the Java SDK. 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. Thanks, Andrew. I've reviewed the changes in bug 1325323, and everything looks good to me. Moving to VERIFIED. This content is now live on the Customer Portal: 3.6 https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.6/html-single/Java_SDK_Guide/index.html#ApiBuilder_Methods 3.5 https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.5/html-single/Technical_Guide/index.html#Api_Constructor_Arguments Closing. |
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.