Bug 1219797 - [Docs][Tech] Group API Change is not documented
Summary: [Docs][Tech] Group API Change is not documented
Keywords:
Status: CLOSED CURRENTRELEASE
Alias: None
Product: Red Hat Enterprise Virtualization Manager
Classification: Red Hat
Component: Documentation
Version: 3.5.0
Hardware: Unspecified
OS: All
unspecified
low
Target Milestone: ---
: ---
Assignee: Julie
QA Contact: Tahlia Richardson
URL:
Whiteboard:
Depends On:
Blocks: 1244999
TreeView+ depends on / blocked
 
Reported: 2015-05-08 10:15 UTC by Alexandros Gkesos
Modified: 2019-07-16 11:58 UTC (History)
10 users (show)

Fixed In Version:
Doc Type: Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed: 2015-09-24 07:18:31 UTC
oVirt Team: ---
Target Upstream Version:
Embargoed:


Attachments (Terms of Use)

Description Alexandros Gkesos 2015-05-08 10:15:26 UTC
Title: Changes needed on RHEV-M 3.5 Technical Guide: Chapter 35. Groups

Describe the issue: 

The API to add and manage Groups has changed between 3.4 and 3.5, but the documentation was not updated.

https://access.redhat.com/documentation/en-US/Red_Hat_Enterprise_Virtualization/3.5/html-single/Technical_Guide/index.html#chap-Groups

The domain.id|name has to be specified too, to add a group. Previously it was extracted from the Group name. 
A request as specified in the docs gets this response:

<fault>
<reason>Incomplete parameters</reason>
<detail>Group [domain.id|name] required for add</detail>
</fault>

The representation of groups has changed too.

3.4:
    <group href="/api/groups/groupID" id="groupID">
        <name>NAME</name>
        <link href="/api/groups/groupID/permissions" rel="permissions"/>
        <link href="/api/groups/groupID/roles" rel="roles"/>
        <link href="/api/groups/groupID/tags" rel="tags"/>
        <domain href="/api/domains/domainID" id="domainID"/>
    </group>

3.5:
    <group href="/api/groups/groupID" id="groupID">
        <name>NAME</name>
        <link href="/api/groups/groupID/permissions" rel="permissions"/>
        <link href="/api/groups/groupID/roles" rel="roles"/>
        <link href="/api/groups/groupID/tags" rel="tags"/>
        <domain href="/api/domains/domainID" id="domainID">
            <name>domainNAME</name>
        </domain>
        <domain_entry_id>DOMAIN_ENTRY_ID</domain_entry_id>
        <namespace>*</namespace>
    </group>


Suggestions for improvement:

Add the changes


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