Bug #19304

As per API v2 documentation for <server_url>/apidoc/v2/packages.html | GET /katello/api/compare is not working

Added by John Mitsch about 1 year ago. Updated 6 months ago.

Status:Closed
Priority:Normal
Assigned To:John Mitsch
Category:API
Target version:Team Brad - Backlog
Difficulty: Pull request:https://github.com/Katello/katello/pull/7043
Bugzilla link:1442397 Found in Katello release:
Story points-
Velocity based estimate-
ReleaseKatello 3.6.0Release relationshipAuto

Description

Cloned from https://bugzilla.redhat.com/show_bug.cgi?id=1442397

There are two issues here:

- The documentation is incorrect for the compare endpoint, /katello/api/compare does not exist

- There is only a compare endpoint for errata (katello/api/v2/errata/compare), I believe there should be one for packages. The errata endpoint is not listed in the documentation

i.e. here is a working command
curl -X GET -k -u admin:changeme -H "Content-Type: application/json" -d '{"content_view_version_ids": [1,3]}' https://&lt;mybox&gt;.com/katello/api/v2/errata/compare

Description of problem:

As per API doc <server_url>/apidoc/v2/packages.html
Issuing a HTTP GET request to <server_url>/katello/api/compare should list all the packages similar to <server_url>/katello/api/packages but it seems a bug.

Version-Release number of selected component (if applicable):

How reproducible:

100%

Steps to Reproduce:
1. Open katello WebUI and Login,

2. Open https://&lt;server_url&gt;/katello/api/packages

It will list packages

3. Open https://&lt;server_url&gt;/katello/api/compare

It will not list packages but as per documentation - https://&lt;server_url&gt;/apidoc/v2/packages.html it should list.

Actual results:

API to get a comparison of packages doesn't work

Expected results:

It should list packages and also work with parameters available with this API call.

Additional info:

Associated revisions

Revision dc49f7e4
Added by Paul Donohue 6 months ago

Fixes #19304 - /katello/api/<resource>/compare not working

The documentation incorrectly listed "GET /katello/api/compare" instead
of "GET /katello/api/<resource>/compare", routes and templates did not
exist for anything but "GET /katello/api/errata/compare", and
permissions did not exist for "GET /katello/api/errata/compare" or any
of the other resource types.

History

#1 Updated by John Mitsch about 1 year ago

  • Subject changed from As per API v2 documentation for <server_url>/apidoc/v2/packages.html | GET /katello/api/compare is not working to As per API v2 documentation for <server_url>/apidoc/v2/packages.html | GET /katello/api/compare is not working
  • Assigned To set to John Mitsch

#2 Updated by John Mitsch about 1 year ago

  • Target version set to Team Brad - Iteration 13

#3 Updated by John Mitsch about 1 year ago

  • Category changed from ElasticSearch to API
  • Release set to Katello 3.4.1

#4 Updated by Brad Buckingham about 1 year ago

  • Target version changed from Team Brad - Iteration 13 to Team Brad - Backlog

#5 Updated by Justin Sherrill about 1 year ago

  • Release changed from Katello 3.4.1 to Katello Backlog

#6 Updated by The Foreman Bot 7 months ago

  • Status changed from New to Ready For Testing
  • Pull request https://github.com/Katello/katello/pull/7043 added

#7 Updated by Anonymous 6 months ago

  • % Done changed from 0 to 100
  • Status changed from Ready For Testing to Closed

#8 Updated by Justin Sherrill 6 months ago

  • Release deleted (Katello Backlog)

#9 Updated by Justin Sherrill 6 months ago

  • Release set to Katello 3.6.0

Also available in: Atom PDF