carbon-data-specification / Power-Systems-Data

This repository is dedicated to the Power Systems Data Working Group
Other
10 stars 7 forks source link

Documentation of pagination in missing in the metadata spec #79

Open Pierre-VF opened 1 year ago

Pierre-VF commented 1 year ago

On the metadata spec ( https://github.com/carbon-data-specification/Power-Systems-Data/blob/main/specifications/cdsc-wg2-03.md ), the semantics of the pagination is undocumented.

It might be a good idea to indicate how this is expected to work in the future as part of the "Response Object" definition (e.g., ("next": null, "previous": null) indicates that pagination is not used, while relevant pagination would look like ("next": X, "previous": Y) where X and Y are to be replaced by realistic values for the example)