Bug 2208467
| Summary: | [RFE] Provide list of changes in API calls between major releases | ||
|---|---|---|---|
| Product: | Red Hat Satellite | Reporter: | Stefan Nemeth <snemeth> |
| Component: | API | Assignee: | Adam Lazik <alazik> |
| Status: | CLOSED CURRENTRELEASE | QA Contact: | Satellite QE Team <sat-qe-bz-list> |
| Severity: | unspecified | Docs Contact: | |
| Priority: | unspecified | ||
| Version: | 6.14.0 | CC: | ahumbe, alazik, lblicha, momran, pmoravec |
| Target Milestone: | Unspecified | Keywords: | Documentation, Triaged |
| Target Release: | Unused | ||
| Hardware: | Unspecified | ||
| OS: | Unspecified | ||
| Whiteboard: | |||
| Fixed In Version: | Doc Type: | If docs needed, set a value | |
| Doc Text: | Story Points: | --- | |
| Clone Of: | Environment: | ||
| Last Closed: | 2023-12-04 11:19:06 UTC | Type: | Bug |
| Regression: | --- | Mount Type: | --- |
| Documentation: | --- | CRM: | |
| Verified Versions: | Category: | --- | |
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |
| Cloudforms Team: | --- | Target Upstream Version: | |
| Embargoed: | |||
|
Description
Stefan Nemeth
2023-05-19 07:40:56 UTC
Hi! I am currently in the process of figuring out the potential changes in number/type of some API endpoints. I will update this ticket once I have more concrete info on the subject. New API endpoints: /api/hostgroups/:id/ansible_roles/:ansible_role_id /api/hosts/:id/ansible_roles/:ansible_role_id /api/organizations/:organization_id/rh_cloud/missing_hosts /katello/api/repositories/:repository_id/sync /api/webhooks/:id/test Removed API endpoints: /katello/api/package_group /katello/api/organizations/:organization_id/products/:product_id/sync I will now confirm the function of each added and removed endpoint and than add it to the release notes. After discussion with Marie Hornickova, we decided to have separate lists for added, fixed, and removed endpoints to preserve our release note structure. the release notes will be in sections New features, Bufixes, and Removed functionality respectively. I will reuse https://bugzilla.redhat.com/show_bug.cgi?id=2164400 to introduce the added endpoints, since two of them are already documented there and it will avoid duplication of information. I will use this ticket for the fixed endpoint. For the removed endpoints, I have created https://issues.redhat.com/browse/SAT-20654. All three release notes are currently undergoing final writer review. The current form is in this document: https://docs.google.com/document/d/1-vxqeTHdQKxkVlW_pWhQx3kzbYBsL03wmeN2bnTZk2A/edit. The release notes are now available in preview. New endpoints: https://dxp-docp-prod.apps.ext-waf.spoke.prod.us-west-2.aws.paas.redhat.com/documentation/en-us/red_hat_satellite/6.14/html-single/release_notes/index?lb_target=preview#BZ-2164400 Fixed endpoint: https://dxp-docp-prod.apps.ext-waf.spoke.prod.us-west-2.aws.paas.redhat.com/documentation/en-us/red_hat_satellite/6.14/html-single/release_notes/index?lb_target=preview#0 Removed endpoints: https://dxp-docp-prod.apps.ext-waf.spoke.prod.us-west-2.aws.paas.redhat.com/documentation/en-us/red_hat_satellite/6.14/html-single/release_notes/index?lb_target=preview#1 For some reason, word "Jira" causes some weird stuff to happen with links on this page, thus for the fixed endpoint find "katello/api/repositories/:repository_id/sync now correctly obtains repository synchronization status" in https://dxp-docp-prod.apps.ext-waf.spoke.prod.us-west-2.aws.paas.redhat.com/documentation/en-us/red_hat_satellite/6.14/html-single/release_notes/index?lb_target=preview#bug-fixes and for the removed endpoints find "Removed API endpoints" in https://dxp-docp-prod.apps.ext-waf.spoke.prod.us-west-2.aws.paas.redhat.com/documentation/en-us/red_hat_satellite/6.14/html-single/release_notes/index?lb_target=preview#removed-functionality |