Uploaded image for project: 'Active and Available Inventory'
  1. Active and Available Inventory
  2. AAI-2460

Automatic pagination of arrays of Resources and Traversal responses

XMLWordPrintable

    • Icon: Story Story
    • Resolution: Won't Do
    • Icon: Medium Medium
    • Frankfurt Release
    • None
    • None

      Based on discussions of AAI-2457 during https://wiki.onap.org/display/DW/2019-05-23+AAI+Developers+Meeting

      In the current system, when returning arrays of objects from Resources and Traversal microservices, the call will either succeed by responding with a full array of objects or it will fail with an error message about "too many objects". There appears to be no in-between response that shows partial results.

      However, there is pagination functionality described in https://wiki.onap.org/pages/viewpage.action?pageId=43386724
      which needs to be explicitly requested. In that case, the response does include information
      that can be used to retrieve the objects in batches over successive calls.

      Suggestion is to make the pagination information an automatic part of the responses for all APIs that return arrays i.e. the pagination query parameters should be the default for the API paths containing "plurals", e.g.

      • resultIndex=1
      • resultSize=10

      The "max depth" configuration that restricts certain queries and results in "too many objects" errors could then be relaxed or removed as a policy, since the microservices would have alternative means of defending against accidental Denial-of-Service due to traversing too many object and relationships.

            jimmydot jimmydot
            keong keong
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: