Bug 1381414

Summary:	[Bug] Satellite-5 API "listActiveSystems", incorrect information listed in the API doc over Satellite Server Web UI
Product:	Red Hat Satellite 5	Reporter:	anerurka
Component:	Docs API Guide	Assignee:	satellite-doc-list
Status:	CLOSED NEXTRELEASE	QA Contact:	satellite-doc-list
Severity:	medium	Docs Contact:
Priority:	medium
Version:	570	CC:	tlestach
Target Milestone:	---
Target Release:	---
Hardware:	x86_64
OS:	Linux
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2017-06-09 13:31:54 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	---
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	---	Target Upstream Version:

Description anerurka 2016-10-04 03:38:37 UTC

Description of problem:

[Bug] Satellite-5 API "listActiveSystems", incorrect information listed in the API doc over Satellite Server Web UI

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

v.5.6 and v.5.7


How reproducible:

As per the API doc below is the information provided for API "listActiveSystems" --> https://access.redhat.com/documentation/en-US/Red_Hat_Satellite/5.7/html-single/API_Guide/index.html#idm96959328

++++++++++

34.47. Method: listActiveSystems
Returns a list of active servers visible to the user.
⁠Parameters

    string sessionKey 

⁠Returns

    array
        struct system
            int id
            string name
            dateTime.iso8601 last_checkin - Last time server successfully checked in 

++++++++


- However as per the API doc available over Satellite Server below information is present -> "https://satellite.example.com/rhn/apidoc/handlers/SystemHandler.jsp#listActiveSystems"

+++++++++

 Method: listActiveSystems
Description:
Returns a list of active servers visible to the user.

Parameters:

    string sessionKey

Returns:

    array:
        struct - system
            int "id"
            string "name"
            dateTime.iso8601 "last_checkin" - Last time server successfully checked in
            dateTime.iso8601 "last_boot" - Last server boot time
            dateTime.iso8601 "created" - Server registration time

++++++++++


1. Navigate to url --> "https://satellite.example.com/rhn/apidoc/handlers/SystemHandler.jsp#listActiveSystems"

Actual results:

- Actual results shows that the API will also list "last boot time" and "created time" for the client server.


Expected results:

- As per the API doc --> https://access.redhat.com/documentation/en-US/Red_Hat_Satellite/5.7/html-single/API_Guide/index.html#idm96959328 

- "last boot time" and "created time" for the client server will not be listed


Additional info:

- This needs to be fixed over the Satellite Server ""https://satellite.example.com/rhn/apidoc/handlers/SystemHandler.jsp#listActiveSystems" as it creates the confusion regarding the expected ouput from the above API.

Comment 1 Tomas Lestach 2017-06-09 13:31:54 UTC

This is not a bug in Satellite API doc, that's shipped with the product.

last_boot and created attributed were added to the API returned struct in Bug 1179479.

The docs on access.redhat.com hasn't been updated since then (what is expected).
I expect this to change with the Sat 5.8 release. That's why I'm closing the BZ NEXTRELEASE.