Bug 852388
| Summary: | [apidoc] No documentation for "remote" actions in katello/apidoc/ | ||
|---|---|---|---|
| Product: | Red Hat Satellite | Reporter: | Garik Khachikyan <gkhachik> |
| Component: | API | Assignee: | Ivan Necas <inecas> |
| Status: | CLOSED ERRATA | QA Contact: | Garik Khachikyan <gkhachik> |
| Severity: | medium | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 6.0.1 | CC: | asettle, inecas, mbacovsk, mkoci, mmccune, omaciel, ppokorny, sachua |
| Target Milestone: | Unspecified | Keywords: | Triaged |
| Target Release: | Unused | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| 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.
|
Story Points: | --- |
| Clone Of: | Environment: | ||
| Last Closed: | 2012-12-04 19:52:03 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
Garik Khachikyan
2012-08-28 11:09:18 UTC
Providers and Subscriptions added in 1081951 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 The systems controller documentation waiting to merge https://github.com/Katello/katello/pull/648 PR #645 merged in, a8be59 PR #643 merged in, 6c3f5d PR #648 merged in, d683e16 Taking the system group apidoc System group*: https://github.com/Katello/katello/pull/664 PR #664 merged in, fea5e2a Taking the last ones - Filters and Sync Filters, sync: https://github.com/Katello/katello/pull/677 merged PR #677 merged in 014cbe7 # 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 Fixed in apipie-rails in commit: 6e1e6937e42dda524d669ef6557316679fe6681b # 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 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 getting rid of 6.0.0 version since that doesn't exist |