Versions Compared

Old Version 27

changes.mady.by.user Rajesh Kumar

Saved on

compared with

New Version Current

changes.mady.by.user Rajesh Kumar

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

#IssuesNotesDecision
1How to support pagination.we need to decide on how to support pagination for query API from two possible alternatives given below (pagination over fragments or pagination over anchors)

it was discussed in weekly meeting and decided by team members to implement pagination over anchors. 

2Default page sizeshould we go with some default page size or query all records if pagination parameter in not provided. 

By default if pagination parameter in not provided then query all records.

Pagination over fragments 

...

Response Headers

Headerdescription
totalResultstotalPagestotal Total number of available records (achors)totalPagestotal nulber of pages.pages for given page size

Response body

FormatExample

[

{"anchorName":"anchor-01",

"dataNodes":[{data-tree1},...{data-tree-n}]

...

,{"anchorName":"anchor-02",

"dataNodes": [{datatree1},...,{data-tree-n}]

}

]


Code Block
titleExample
collapsetrue
[
   {
      "anchorName":"anchor01",
      "dataNodes":[
         {
            "test:bookstore":{
               "bookstore-name":"Chapters",
               "categories":[
                  {
                     "code":1,
                     "name":"SciFi"
                  }
               ]
            }
         }
      ]
   },
   {
      "anchorName":"anchor02",
      "dataNodes":[
         {
            "test:bookstore":{
               "bookstore-name":"store01",
               "categories":[
                  {
                     "code":2,
                     "name":"SciFi"
                  }
               ]
            }
         }
      ]
   }
]


...