Bug 1391226 - [RFE] Add additional use cases to API DOCs
Summary: [RFE] Add additional use cases to API DOCs
Keywords:
Status: CLOSED WONTFIX
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Docs API Guide
Version: 6.2.2
Hardware: All
OS: Linux
unspecified
low vote
Target Milestone: Unspecified
Assignee: satellite-doc-list
QA Contact: satellite-doc-list
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-11-02 20:02 UTC by Josh Foots
Modified: 2020-04-15 14:48 UTC (History)
1 user (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2017-07-11 23:37:21 UTC
Target Upstream Version:

Attachments (Terms of Use)
Add an attachment (proposed patch, testcase, etc.)

Description Josh Foots 2016-11-02 20:02:38 UTC 
Document URL: 

https://access.redhat.com/documentation/en/red-hat-satellite/6.2/paged/api-guide/

https://<satellite.url>/apidoc/v2.html

Section Number and Name: 

Chapter 2 and 4

Describe the issue:

Some additional use cases and examples could be used in our API docs. 

One such case would be associating provisioning templates with an OS via the API. 

The apidoc/v2.html doc has the calls in it but no reference on how to use them.  

Suggestions for improvement: 

Examples of different common scenarios would be appreciated. 

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