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 2159105 - Remove deprecated & not working API endpoints from APIdoc
Summary: Remove deprecated & not working API endpoints from APIdoc
Keywords:
Status: CLOSED ERRATA
Alias: None
Product: Red Hat Satellite
Classification: Red Hat
Component: Repositories
Version: 6.11.4
Hardware: Unspecified
OS: Unspecified
unspecified
medium
Target Milestone: 6.14.0
Assignee: Quinn James
QA Contact: Cole Higgins
URL:
Whiteboard:
: 2084485 (view as bug list)
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2023-01-08 14:34 UTC by Pavel Moravec
Modified: 2024-02-15 08:33 UTC (History)
6 users (show)

Fixed In Version: rubygem-katello-4.9.0.2-1
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2023-11-08 14:18:13 UTC
Target Upstream Version:
Embargoed:

Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Foreman Issue Tracker 36530 0 Normal New Remove deprecated & not working API endpoints from APIdoc 2023-06-23 19:03:47 UTC
Red Hat Issue Tracker SAT-17438 0 None None None 2023-05-18 14:44:29 UTC
Red Hat Knowledge Base (Solution) 7027681 0 None None None 2023-08-09 14:30:22 UTC
Red Hat Product Errata RHSA-2023:6818 0 None None None 2023-11-08 14:19:08 UTC

Description Pavel Moravec 2023-01-08 14:34:46 UTC 
Description of problem:
APIdoc shows below endpoints that do not further work and an attempt to use them returns 404 error. Please remove them from APIdoc:

GET /katello/api/sync_plans/:sync_plan_id/products 	List of Products for sync plan

GET /katello/api/organizations/:organization_id/products/:product_id/sync 	Get status of repo synchronisation for given product

GET /katello/api/repositories/:repository_id/sync 	Get status of synchronisation for given repository

The latest endpoint does not return 404 but 500 error "unknown keyword: :use_admin_as_cn_pulp_cert".


(proper API endpoints instead of above are:

1) List of Products for sync plan :
/katello/api/v2/products?sync_plan_id=:sync_plan_id&organization_id=:org_id

2) Get status of repo synchronisation for given product :
/katello/api/v2/products/:product_id?organization_id=:organization_id

3) Get status of synchronisation for given repository :
/katello/api/repositories/:id  and "last_sync" section


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


How reproducible:
100%


Steps to Reproduce:
1. Login to WebUI, open apidoc/v2.html URI and grep for above endpoints.
2. Try to use the endpoints.


Actual results:
1. they are listed but not working.


Expected results:
1. the endpoints are not listed


Additional info:
Comment 1 Ian Ballou 2023-06-01 20:57:33 UTC 
These API endpoints should work -- we should repair them rather than remove them.
Comment 3 Ian Ballou 2023-06-12 18:02:50 UTC 
*** Bug 2084485 has been marked as a duplicate of this bug. ***
Comment 4 Quinn James 2023-06-23 19:03:46 UTC 
Created redmine issue https://projects.theforeman.org/issues/36530 from this bug
Comment 5 Quinn James 2023-06-23 19:19:22 UTC 
Ian and I met up today and decided it didn't make sense to keep the `GET /katello/api/organizations/:organization_id/products/:product_id/sync` API endpoint, due to `/katello/api/v2/products/:product_id?organization_id=:organization_id` being the more reasonable workflow. I have fixes in the works for the other two endpoints.
Comment 6 Bryan Kearney 2023-07-03 16:02:35 UTC 
Moving this bug to POST for triage into Satellite since the upstream issue https://projects.theforeman.org/issues/36530 has been resolved.
Comment 11 errata-xmlrpc 2023-11-08 14:18:13 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 (Important: Satellite 6.14 security and bug fix update), 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-2023:6818
Note You need to log in before you can comment on or make changes to this bug.