Bug 1698378 - the API documentation and the release note do not mention changes done to the retirement api calls
Summary: the API documentation and the release note do not mention changes done to the...
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat CloudForms Management Engine
Classification: Red Hat
Component: Documentation
Version: 5.10.2
Hardware: All
OS: All
unspecified
urgent
Target Milestone: GA
: 5.10.3
Assignee: Suyog Sainkar
QA Contact: Red Hat CloudForms Documentation
Red Hat CloudForms Documentation
URL:
Whiteboard:
: 1698380 (view as bug list)
Depends On:
Blocks:
TreeView+ depends on / blocked
 
Reported: 2019-04-10 09:25 UTC by Felix Dewaleyne
Modified: 2019-04-24 08:58 UTC (History)
6 users (show)

Fixed In Version:
Doc Type: If docs needed, set a value
Doc Text:
Clone Of:
Environment:
Last Closed: 2019-04-12 15:57:55 UTC
Category: Bug
Cloudforms Team: Documentation
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)


Links
System ID Private Priority Status Summary Last Updated
Red Hat Bugzilla 1698116 0 high CLOSED service bundle retirement initiated by API fails at check_service_retirement on an unknown method error 2021-02-22 00:41:40 UTC

Description Felix Dewaleyne 2019-04-10 09:25:07 UTC
Document URL: 

https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.7/html-single/release_notes/index
https://access.redhat.com/documentation/en-us/red_hat_cloudforms/4.7/html-single/red_hat_cloudforms_rest_api/index#retire-service-immediately

Section Number and Name: 

release note : section 4, enhancements
API documentation : 3.7.5, 3.7.6, 3.7.7, three sections related to service retirement

Describe the issue: 

the correct api call now is 
~~~
POST POST /api/services/<<id>>
{
	"action" : "request_retire"
}
~~~
calls to the ancient method results in retirement to fail (bz#1698116)

Suggestions for improvement: 

we need to update the documentation to cover request_retire

Additional information: 
related to bug#1698116

Comment 2 dmetzger 2019-04-10 17:12:36 UTC
*** Bug 1698380 has been marked as a duplicate of this bug. ***


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