Bug 1990004

Summary:	Add apidoc for RH Cloud - Inventory APIs.
Product:	Red Hat Satellite	Reporter:	Jameer Pathan <jpathan>
Component:	RH Cloud - Inventory	Assignee:	Shimon Shtein <sshtein>
Status:	CLOSED ERRATA	QA Contact:	Jameer Pathan <jpathan>
Severity:	medium	Docs Contact:
Priority:	unspecified
Version:	6.10.0	CC:	apatel, aruzicka, osousa, sshtein, zhunting
Target Milestone:	6.10.0	Keywords:	Triaged
Target Release:	Unused
Hardware:	Unspecified
OS:	Unspecified
Whiteboard:
Fixed In Version:	tfm-rubygem-foreman_rh_cloud-4.0.26	Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2021-11-16 14:13:02 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:
Embargoed:

Description Jameer Pathan 2021-08-04 14:37:00 UTC

Description of problem:
Add apidoc for RH Cloud - Inventory APIs.

Version-Release number of selected component (if applicable):
- Satellite 6.10.0 snap 11
- tfm-rubygem-foreman_rh_cloud-4.0.24.1-1.el7sat.noarch

How reproducible:
- Always

Steps to Reproduce:
1. Go to https://satellite.example.com/apidoc/v2 page.

Actual results:
- Information related to RH Cloud - Inventory APIs is not available.

Expected results:
- All RH Cloud - Inventory APIs are listed with proper description and parameters it uses/require.

Additional info:
- Refer BZ#1976231#c1 and BZ#1965234#c3 for more information.
- There's typo for `Enable cloud connector` api. It should be "/api/rh_cloud/enable_connector" instead of "/apirh_cloud/enable_connector".

Comment 1 Jameer Pathan 2021-09-23 07:51:41 UTC

Verified:

Verified with:
- Satellite 6.10.0 snap 20
- tfm-rubygem-foreman_rh_cloud-4.0.26-1.el7sat.noarch

Test steps:
1. Go to https://satellite.example.com/apidoc/v2 page.

Observation:
- All RH Cloud - Inventory APIs are listed with proper description and parameters it uses/require.

Additional info:

*********************************************************
Inventory
Resource	                                                     Description
GET /api/organizations/:organization_id/rh_cloud/report	             Download latest report
POST /api/organizations/:organization_id/rh_cloud/report	     Start report generation
POST /api/organizations/:organization_id/rh_cloud/inventory_sync     Start inventory synchronization
POST /api/rh_cloud/enable_connector	                             Enable cloud connector

*********************************************************
Params
Param name	              Description
location_id(optional)	      Set the current location context for the request (Validations: Integer)

organization_id(required)     Set the current organization context for the request (Validations: Integer)

*********************************************************

Comment 4 errata-xmlrpc 2021-11-16 14:13:02 UTC

Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory (Moderate: Satellite 6.10 Release), and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://access.redhat.com/errata/RHSA-2021:4702