Red Hat Satellite engineering is moving the tracking of its product development work on Satellite to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "Satellite project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs will be migrated starting at the end of May. If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "Satellite project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/SAT-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.
Bug 1990004 - Add apidoc for RH Cloud - Inventory APIs.
Summary: Add apidoc for RH Cloud - Inventory APIs.
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: RH Cloud - Inventory
Version: 6.10.0
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: 6.10.0
Assignee: Shimon Shtein
QA Contact: Jameer Pathan
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2021-08-04 14:37 UTC by Jameer Pathan
Modified: 2021-11-16 14:13 UTC (History)
5 users (show)

Fixed In Version: tfm-rubygem-foreman_rh_cloud-4.0.26
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2021-11-16 14:13:02 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHSA-2021:4702 0 None None None 2021-11-16 14:13:12 UTC

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
Note You need to log in before you can comment on or make changes to this bug.