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 852388 - [apidoc] No documentation for "remote" actions in katello/apidoc/
Summary: [apidoc] No documentation for "remote" actions in katello/apidoc/
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: API
Version: 6.0.1
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: Unspecified
Assignee: Ivan Necas
QA Contact: Garik Khachikyan
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2012-08-28 11:09 UTC by Garik Khachikyan
Modified: 2019-09-25 21:09 UTC (History)
8 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Documentation was missing on specific API calls and users were unable to understand these API calls. This fix added the required documentation to help users understand the API calls.
Clone Of:
Environment:
Last Closed: 2012-12-04 19:52:03 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Product Errata RHSA-2012:1543 0 normal SHIPPED_LIVE Important: CloudForms System Engine 1.1 update 2012-12-05 00:39:57 UTC

Description Garik Khachikyan 2012-08-28 11:09:18 UTC 
Description of problem:
having recent katello-api-docs was unable to find the documentation for the remote calls.

Version-Release number of selected component (if applicable):
katello-api-docs-1.1.7-1.git.31.8662665.el6.noarch

How reproducible:
always

Steps to Reproduce:
1. install katello-api-docs
2. visit https://<fqdn>/katello/apidoc
3. try to find remote actions related doc
  
Actual results:
no doc

Expected results:
doc related to remote action API calls/

Additional info:
Comment 1 Pavel Pokorny 2012-09-12 10:58:08 UTC 
Providers and Subscriptions added in 1081951
Comment 2 Pavel Pokorny 2012-09-12 12:13:53 UTC 
Another API controllers which are not documented:

[1] SyncPlans
[1] SystemPackages
[1] Tasks
[2] TemplatesContent
[2] Templates

Filters
Sync
Systems
SystemGroupErrata
SystemGroupPackages
I added last two to [3] list.

And then PulpProxiesController, CandlepinProxiesController which won't be probably documented at all.

[1] https://github.com/Katello/katello/pull/645
[2] https://github.com/Katello/katello/pull/643
[3] https://fedorahosted.org/katello/wiki/APIDocumentationEfforts
Comment 3 Ivan Necas 2012-09-12 14:38:56 UTC 
The systems controller documentation waiting to merge https://github.com/Katello/katello/pull/648
Comment 4 Martin Bacovsky 2012-09-13 10:14:52 UTC 
PR #645 merged in, a8be59
PR #643 merged in, 6c3f5d
PR #648 merged in, d683e16
Comment 5 Martin Bacovsky 2012-09-13 10:21:44 UTC 
Taking the system group apidoc
Comment 6 Martin Bacovsky 2012-09-14 09:52:55 UTC 
System group*: https://github.com/Katello/katello/pull/664
Comment 7 Martin Bacovsky 2012-09-14 10:59:15 UTC 
PR #664 merged in, fea5e2a
Comment 8 Martin Bacovsky 2012-09-14 13:18:21 UTC 
Taking the last ones - Filters and Sync
Comment 9 Martin Bacovsky 2012-09-17 13:51:20 UTC 
Filters, sync: https://github.com/Katello/katello/pull/677
Comment 10 Mike McCune 2012-09-17 16:20:19 UTC 
merged
Comment 11 Martin Bacovsky 2012-09-18 12:17:01 UTC 
PR #677 merged in 014cbe7
Comment 14 Garik Khachikyan 2012-10-04 12:21:04 UTC 
# REOPEN

seems it's filled (the gap in api calls about remote actions and not only :)), BUT:

there is an issue with CFSE, simply clicking in any url of documented method, it makes HTTP 404 Not found error, because links to: "https://fqdn/katello/apidoc/sync_plans.html" (note the /katello/ there)

So the directory for CFSE is /cfse/ and not the /katello/

checked on:
---
katello-api-docs-1.1.12-12.el6cf.noarch
Comment 15 Ivan Necas 2012-10-08 09:48:34 UTC 
Fixed in apipie-rails in commit:

6e1e6937e42dda524d669ef6557316679fe6681b
Comment 18 Garik Khachikyan 2012-10-17 08:54:03 UTC 
# VERIFIED

My pleasure to state that it now fixed. yay!

thanks Ivan for the fix.

done against packages:
---
katello-api-docs-1.1.12-16.el6cf.noarch
katello-1.1.12-16.el6cf.noarch
rubygem-apipie-rails-0.0.11-3.el6cf.noarch
Comment 20 errata-xmlrpc 2012-12-04 19:52:03 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, and where to find the updated
files, follow the link below.

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

http://rhn.redhat.com/errata/RHSA-2012-1543.html
Comment 21 Mike McCune 2013-08-16 18:05:11 UTC 
getting rid of 6.0.0 version since that doesn't exist
Note You need to log in before you can comment on or make changes to this bug.