Bug 1698378

Summary:	the API documentation and the release note do not mention changes done to the retirement api calls
Product:	Red Hat CloudForms Management Engine	Reporter:	Felix Dewaleyne <fdewaley>
Component:	Documentation	Assignee:	Suyog Sainkar <ssainkar>
Status:	CLOSED CURRENTRELEASE	QA Contact:	Red Hat CloudForms Documentation <cloudforms-docs>
Severity:	urgent	Docs Contact:	Red Hat CloudForms Documentation <cloudforms-docs>
Priority:	unspecified
Version:	5.10.2	CC:	dmetzger, fdewaley, kdixon, obarenbo, ssainkar, vaclav.miller
Target Milestone:	GA
Target Release:	5.10.3
Hardware:	All
OS:	All
Whiteboard:
Fixed In Version:		Doc Type:	If docs needed, set a value
Doc Text:		Story Points:	---
Clone Of:		Environment:
Last Closed:	2019-04-12 15:57:55 UTC	Type:	Bug
Regression:	---	Mount Type:	---
Documentation:	---	CRM:
Verified Versions:		Category:	Bug
oVirt Team:	---	RHEL 7.3 requirements from Atomic Host:
Cloudforms Team:	Documentation	Target Upstream Version:
Embargoed:

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. ***