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 1261573 - API docs for incremental update incorrectly mark update_systems[included] as required
Summary: API docs for incremental update incorrectly mark update_systems[included] as ...
Keywords:
Status: CLOSED NOTABUG
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: API
Version: 6.1.2
Hardware: Unspecified
OS: Unspecified
medium
medium
Target Milestone: Unspecified
Assignee: Zach Huntington-Meath
QA Contact: Katello QA List
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2015-09-09 17:42 UTC by jaudet
Modified: 2019-04-01 20:27 UTC (History)
3 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2016-05-02 20:38:32 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)
Output of foreman-debug from a RHEL 7.1 system. (2.25 MB, application/x-xz)
2015-09-09 17:42 UTC, jaudet
no flags Details

Description jaudet 2015-09-09 17:42:25 UTC
Created attachment 1071860 [details]
Output of foreman-debug from a RHEL 7.1 system.

Document URL: 
https://satellite6.example.com/apidoc/v2/content_view_versions/incremental_update.html

Section Number and Name: 

Describe the issue:
The API docs mark each portion of an API call as either "required" or "optional". The update_systems[included] portion of the `POST /katello/api/content_view_versions/incremental_update` call is marked as required. But this is not true. It's definitely possible to perform an incremental update without specifying this bit of information.

Suggestions for improvement: 

Additional information: 
A test for this issue is in place. This [1] pull request performs an incremental update and passes the following JSON payload:

    payload = {
        'content_view_version_environments': [{
            'content_view_version_id': content_view.version[0].id,
            'environment_ids': [
                environment.id
                for environment
                in content_view.version[0].read().environment
            ],
        }],
        'add_content': {'puppet_module_ids': [puppet_module.id]},
    }

[1] https://github.com/SatelliteQE/robottelo/pull/2739

Comment 1 Andrew Dahms 2016-01-04 06:36:34 UTC
Assigning to Byron for review.

Comment 2 David O'Brien 2016-01-04 07:26:10 UTC
This looks like part of the actual apidoc, not the "API Guide". This would be better raised against the api itself.

Comment 3 David O'Brien 2016-01-15 03:21:00 UTC
Resetting to API component. Docs team doesn't maintain this part of API.

Comment 5 Zach Huntington-Meath 2016-05-02 20:38:32 UTC
This command is now known as update_hosts[included]. This command is a subcommand of the optional command update_hosts. However, if the update_hosts command is given update_hosts[included] is required, which is why it shows up as required in the documentation.


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