belgif / rest-guide

REST Guidelines of Belgian government institutions
https://www.belgif.be/specification/rest/api-guide/
Apache License 2.0
25 stars 4 forks source link

Clarify the meaning of 'total' w.r.t. filtering #115

Closed JDMKSZ closed 1 year ago

JDMKSZ commented 1 year ago

The total property is used to indicate the number of items in a collection, mostly used with pagination. It was not clear to me if this was the total in the entire collection or the total of the result set. These are different numbers if filtering is applied. Also it should be made explicit if the property can be used if no pagination is used.