Bug 1047488
| Summary: | duplicate method create | ||||||
|---|---|---|---|---|---|---|---|
| Product: | Red Hat Satellite 5 | Reporter: | Sharuzzaman Ahmat Raslan <sharuzzaman> | ||||
| Component: | Docs API Guide | Assignee: | David O'Brien <daobrien> | ||||
| Status: | CLOSED WONTFIX | QA Contact: | Dan Macpherson <dmacpher> | ||||
| Severity: | low | Docs Contact: | |||||
| Priority: | low | ||||||
| Version: | unspecified | CC: | cperry | ||||
| Target Milestone: | --- | Keywords: | Triaged | ||||
| Target Release: | --- | ||||||
| Hardware: | All | ||||||
| OS: | Linux | ||||||
| Whiteboard: | |||||||
| Fixed In Version: | Doc Type: | Bug Fix | |||||
| Doc Text: | Story Points: | --- | |||||
| Clone Of: | Environment: | ||||||
| Last Closed: | 2014-10-21 23:58:41 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: | |||||||
| Bug Depends On: | |||||||
| Bug Blocks: | 1018166 | ||||||
| Attachments: |
|
||||||
this bug report is also applicable to other method name, such as: getDetails getRepoDetails listAllPackages and many more This bug can be worked on early during the planning stages for Satellite 5.7. The API Guide is being redesigned for the next release and this material will no longer appear. Suitable references will be included in the new doc to access individual API calls. |
Created attachment 843720 [details] duplicate method create Description of problem: The method "create" is duplicated 3 times, in section 10.7, 10.8 and 10.9. It is better to only have the method mentioned once, but document why there are 3 different thing. The difference between each of them is: 10.7: string checksum Type - checksum type for this channel, used for yum repository metadata generation sha1 - Offers widest compatibility with clients sha256 - Offers highest security, but is compatible only with newer clients e.g. Red Hat Enterprise Linux 6 and newer. struct - gpgKey string url - GPG key URL string id - GPG key ID string fingerprint - GPG key Fingerprint 10.8: string checksum Type - checksum type for this channel, used for yum repository metadata generation sha1 - Offers widest compatibility with clients sha256 - Offers highest security, but is compatible only with newer clients e.g. Red Hat Enterprise Linux 6 and newer. 10.9: nothing about the checksum and GPG key. --- this will reduce confusion to people who are new to the API like me. also, nothing is mentioned about the differences for each of them Version-Release number of selected component (if applicable): Edition 1 How reproducible: Always Steps to Reproduce: 1. Open PDF of Red Hat Satellite 5.6 API Overview 2. Go to page 58 3. Index shown 3 method with name "create" with small differences in each of them Actual results: 3 method with name "create" Expected results: 1 method with name "create", but documenting differences between each of the option Additional info: screenshot attached