Details
-
Type:
Improvement
-
Status: Open
-
Priority:
Major
-
Resolution: Unresolved
-
Affects Version/s: API Docs
-
Fix Version/s: All Time Backlog
-
Component/s: API
-
Labels:
-
Environment:
aml-sapi feature/sapi-documentation branch
Description
Originally, certain endpoints were returning either a List or a Set of objects. However, XML could not generate a response for these (despite @Produces specifying both JSON and XML) and Enunciate could not generate any documentation for these responses.
In order to fix both of these problems at once, either already existing or newly created wrapper classes were used. However, doing so results in changes to the JSON response body at the endpoints where these changes were made.
The endpoints where the response body has changed are the following:
RoleService
===========
/roles/{id}/permissions (changed from Set<String> to SetQueryResponse)
/roles/{id}/assignees/{type} (changed from Set<String[]> to MemberQueryResponse)
GroupService
===========
/groups/{id}/groups (changed from Set<String> to SetQueryResponse)
/groups/{id}/permissions (changed from Set<String> to SetQueryResponse)
/groups/{id}/members/{type} (changed from Set<String[]> to MemberQueryResponse
/groups/{id}/roles (changed from List<Roles> to RoleQueryResponse)
UserService:
===========
/users/{id}/groups (changed from Set<String> to SetQueryResponse)
/users/{id}/roles (changed from Set<String> to SetQueryResponse)
/users/{id}/permissions (changed from Set<String> to SetQueryResponse)
RealmService:
===========
/realms/ (changed from List<RealmMapping> to RealmQueryResponse)
