Bug 1351733 - APIDoc incorrect for accessing bootdisks
Summary: APIDoc incorrect for accessing bootdisks
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Bootdisk Plugin
Version: 6.1.8
Hardware: All
OS: Linux
high
high
Target Milestone: Unspecified
Assignee: Swapnil Abnave
QA Contact: Bruno Rocha
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2016-06-30 16:55 UTC by ckyriaki
Modified: 2020-03-11 15:09 UTC (History)
8 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2018-02-21 16:32:26 UTC
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Foreman Issue Tracker 17552 0 None None None 2016-12-01 16:45:07 UTC

Description ckyriaki 2016-06-30 16:55:30 UTC
Document URL: https://satellite.local:8443/apidoc/v2/disks/host.json and https://satellite.local:8443/apidoc/v2/disks#description-host

Section Number and Name: 

Describe the issue: apidoc on satellite (6.1.9) points to the wrong disk api url,

Suggestions for improvement: add v2 to the content of those documents after api

Additional information:

Comment 1 Stephen Benjamin 2016-06-30 17:00:49 UTC
It's actually the API documentation generated inside of Satellite at /apidoc, so I think this belongs in the Bootdisk category - something in either the bootdisk plugin or Apipie needs fixing.

Comment 3 Bryan Kearney 2016-12-06 15:15:48 UTC
Moving this bug to POST for triage into Satellite 6 since the upstream issue http://projects.theforeman.org/issues/17552 has been resolved.

Comment 5 Bruno Rocha 2017-12-18 16:22:36 UTC
Using:
    satellite-6.3.0-22.0.el7sat.noarch

Results:

    The JSON in /apidoc/v2/disks/host.json still shows
    "api_url":"/bootdisk/api/hosts/:host_id"

    The HTML in /apidoc/v2/disks/host.html still shows
    `GET /bootdisk/api/hosts/:host_id`


However, checking the PR https://github.com/theforeman/foreman_bootdisk/pull/34 I see that now `v2` is the default route (otherwise can be passed as a header).

I tested `/bootdisk/api/hosts/1` and got the same results as in `/bootdisk/api/v2/hosts/`

Comment 6 Bryan Kearney 2018-02-21 16:32:26 UTC
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.

https://access.redhat.com/errata/RHSA-2018:0336


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