Bug 1733567

Summary: The API documentation has incorrect data for set_current_group on a user.
Product: Red Hat CloudForms Management Engine Reporter: Joe Vlcek <jvlcek>
Component: APIAssignee: Joe Vlcek <jvlcek>
Status: CLOSED NOTABUG QA Contact: Sudhir Mallamprabhakara <smallamp>
Severity: medium Docs Contact: Red Hat CloudForms Documentation <cloudforms-docs>
Priority: unspecified    
Version: 5.11.0CC: obarenbo
Target Milestone: GA   
Target Release: cfme-future   
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: 2019-07-26 17:58:57 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 Joe Vlcek 2019-07-26 14:40:11 UTC
Description of problem:

The API documentation has incorrect data for set_current_group on a user.

The current, incorrect, data is:

{
  "action" : "set_current_group",
  "resource" : {
    "group" : { "description" : "EvmGroup-auditor" }
  }
}

The correct data should be:

{
  "action" : "set_current_group",
  "resource" : {
    "group" : { "id" : "12" }
  }
}

Comment 3 Joe Vlcek 2019-07-26 17:58:57 UTC
Not a bug

The documented syntax does work

e.g:

request.body = ' 
{
  "action" : "set_current_group",
  "resource" : {
    "current_group" : { "description" : "EvmGroup-super_administrator" }
  }
}
'