Uploaded image for project: 'Confluence Cloud'
  1. Confluence Cloud
  2. CONFCLOUD-83030

The totalSize field is missing from REST API responses

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Not a bug
    • Icon: Medium Medium
    • User - API

      Issue Summary

      The totalSize field is missing from REST API responses, making it hard to implement pagination for big instances.

      Endpoint used for test: https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group/#api-wiki-rest-api-group-get. 

      In case this field is deprecated/removed, please update the documentation with the current information.

      Steps to Reproduce

      1. Send a request to the endpoint GET groups, and check the response body.
      2. Please note that this happens to multiple or even all endpoints on Confluence Cloud. Other endpoint example:[ https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group/#api-wiki-rest-api-group-groupid-membersbygroupid-get|https://developer.atlassian.com/cloud/confluence/rest/v1/api-group-group/#api-wiki-rest-api-group-groupid-membersbygroupid-get]

      Expected Results

      As shown in the documentation, the response should have a totalSize field:

      {
        "results": [
          {
            "type": "group",
            "name": "<string>",
            "id": "<string>",
            "_links": {}
          }
        ],
        "start": 2154,
        "limit": 2154,
        "size": 2154,
        "totalSize": 150,
        "_links": {}
      }
      

      Actual Results

      Response comes with no totalSize field and value:

          ],
          "start": 0,
          "limit": 200,
          "size": 13, 
          "_links": {
              "base": "https://{SITE}.atlassian.net/wiki",
              "context": "/wiki",
              "self": "https://{SITE}.atlassian.net/wiki/rest/api/group"
          }
      }

      Workaround

      Currently, there is no known workaround for this behavior. A workaround will be added here when available.

              Unassigned Unassigned
              9c941f86b120 Pablo Silva
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated:
                Resolved: