Uploaded image for project: 'Nuxeo Platform'
  1. Nuxeo Platform
  2. NXP-19112

Add pagination to user's groups and group's members in the REST API

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Resolved
    • Priority: Minor
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 8.2
    • Component/s: Rest API
    • Epic Link:
    • Tags:
    • Upgrade notes:
      Hide

      The memberUsers and memberGroups field are no longer marshalled in the response on /group/

      {groupname}.

      To force the marshalling of memberUsers and memberGroups fields, use respectively fetch.group=memberUsers and/or fetch.group=memberGroups properties in the request. It will keep returning a list of user/group ids (List of string).

      To fetch the full user or group members of a group (List of users/groups entity), use respectively /group/{groupname}

      /@members or /group/

      {groupname}

      /@groups adapter.

      Show
      The memberUsers and memberGroups field are no longer marshalled in the response on /group/ {groupname}. To force the marshalling of memberUsers and memberGroups fields, use respectively fetch.group=memberUsers and/or fetch.group=memberGroups properties in the request. It will keep returning a list of user/group ids (List of string). To fetch the full user or group members of a group (List of users/groups entity), use respectively /group/{groupname} /@members or /group/ {groupname} /@groups adapter.
    • Sprint:
      nxNag Sprint 8.2.2, nxGang Sprint 8.2.3
    • Story Points:
      5

      Description

      Current implementation of users and groups REST endpoints provide the full list of the groups a given users belongs to and the full list of members of a group.
      This list should be paginated and subpaths should be made available to allow retrieving next pages (ex: /user/<id>/groups and /group/<id>/users)

      –
      New endpoints were added for getting members of a group:

      • /group/ {groupname}/@members

        - /group/{groupname}

        /@groups adapter.
        Full objects are returned.

      And by default, users and groups members are no more marshalled, you can use fetch.group=memberUsers and/or fetch.group=memberGroups.

        Attachments

          Issue Links

          depends on

          Improvement - An improvement or enhancement to an existing feature or task. NXP-19131 Add a configuration property to disable members marshalling on /group

          • Minor - Minor loss of function, or other problem where easy workaround is present.
          • Resolved

            Activity

              People

              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: