Bug 1661096 - [API Guide Review] Restructure the guide to create a section containing target customer scenarios
Summary: [API Guide Review] Restructure the guide to create a section containing targe...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Documentation
Version: 6.4
Hardware: Unspecified
OS: Unspecified
unspecified
unspecified
Target Milestone: Unspecified
Assignee: Sergei Petrosian
QA Contact: Melanie Corr
URL:
Whiteboard:
Depends On: 1660731
Blocks: 1656022
TreeView+ depends on / blocked
 
Reported: 2018-12-20 06:21 UTC by Sergei Petrosian
Modified: 2019-09-26 14:59 UTC (History)
0 users

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-12-21 11:44:22 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Sergei Petrosian 2018-12-20 06:21:39 UTC
Document URL: 
https://access.redhat.com/documentation/en-us/red_hat_satellite/6.4/html/api_guide/

Describe the issue: 
Currently, there are sections on using the API with curl, Ruby, and Python. 

Beyond that, there are sections that are not specific for any tool. They describe working with the API and actual use cases for the API. They all use curl for simplicity. They are:

4.6. Working with Life Cycle Environments
4.1.7. Applying Errata to a Host or Host Collection
4.1.2. Performing Simple Queries
4.1.3. Creating and Modifying Resources
4.5. Using Searches with Pagination Control
4.1.4. Uploading Content to the Satellite Server
4.1.1. Passing JSON Data to the API Call
4.1.5. Overriding Smart Class Parameters
4.1.6. Modifying a Smart Class Parameter Using an External File

Suggestions for improvement: 
Keep only tools related staff for curl. Ruby, Python under their sections accordingly. And create a new section for examples and use cases.

Comment 5 Sergei Petrosian 2018-12-21 11:44:22 UTC
These changes are now live on the customer portal:
https://access.redhat.com/documentation/en-us/red_hat_satellite/6.4/html/api_guide/

Thank you


Note You need to log in before you can comment on or make changes to this bug.