Pagination of endpoints that handle list of objects needs to be improved

[prernaadev01]

Problem description

Currently, API endpoints, which handles list of objects (such as VPs) does not display properly if there are more pages in the response. One of the such endpoint is Trustchain API.

Requirements

We need all the API endpoints, which handle list of objects in their responses, needs to display in much properly manner like the response could have a field "next_url" field to help loop through the results or field such as "total_pages" and "total_results"

Definition of done

1. Improving all the API endpoints involving pagination and make sure their responses are properly displayed.
2. Updating documentation.

Acceptance criteria

100% completion as mentioned in DOD.

[artembuslaev]

Guardian API returns "X-Total-Count" header for each endpoint which contains pagination data, here are some examples:

• Trustchain, i.e. requesting VP documents
• Schemas

It's not clear where the issue has been observed, if this can be clarified it'd be great please. We suspect that the report here records the situation when the headers might have been (wrongly) expected for responses from inside the Policy. These would feature in such responses only when the Document block contains paginationBlock. When this is the case the response to the get request to the paginationBlock would contain total count.