Bug 1046886 - example is for login, but word about retrieving API namespace
Summary: example is for login, but word about retrieving API namespace
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Satellite 5
Classification: Red Hat
Component: Docs API Guide
Version: unspecified
Hardware: All
OS: Linux
low
low
Target Milestone: ---
Assignee: Dan Macpherson
QA Contact: Dan Macpherson
URL:
Whiteboard:
Depends On:
Blocks: sat-docs
TreeView+ depends on / blocked
 
Reported: 2013-12-27 09:10 UTC by Sharuzzaman Ahmat Raslan
Modified: 2015-10-21 02:50 UTC (History)
0 users

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2015-10-21 02:50:32 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
screenshot of the xml-rpc example (110.33 KB, image/png)
2013-12-27 09:11 UTC, Sharuzzaman Ahmat Raslan
no flags Details

Description Sharuzzaman Ahmat Raslan 2013-12-27 09:10:39 UTC
Description of problem:
In page 25, near the botton, the wording:

"For example, use the following XML-RPC request to retrieve a list of all Red Hat Satellite API namespaces:"

describes retrieving API namespace, but the code actually is to login to the system via XML-RPC.

It should be changed to:

"For example, use the following XML-RPC request to login/authenticate the application to Red Hat Satellite:"


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

How reproducible:
Always

Steps to Reproduce:
1. Open Satellite 5.6 API Overview PDF
2. Go to page 25
3. The wording is not correctly describing the example.

Actual results:
The word describing retrieving API namespace

Expected results:
The word should describe about login/authenticate to the Red Hat Satellite

Additional info:
Screenshot attached

Comment 1 Sharuzzaman Ahmat Raslan 2013-12-27 09:11:36 UTC
Created attachment 842224 [details]
screenshot of the xml-rpc example

Comment 2 Dan Macpherson 2014-01-21 15:19:46 UTC
This bug can be worked on early during the planning stages for Satellite 5.7.

Comment 3 Dan Macpherson 2014-01-24 00:45:03 UTC
Corrected in topic 27051:
"For example, use the following XML-RPC request to login to the API and request a session key for authentication:"


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