GeoSamples / sesar-rest-api

SESAR REST API Spring Boot Project
Apache License 2.0
2 stars 1 forks source link

REST API for Published Parent IGSN Last Update Time #15

Open lulin-song opened 4 years ago

lulin-song commented 4 years ago

Implemented the REST API

Screen Shot 2020-06-01 at 10 48 03 AM
ramdeensarah commented 4 years ago

Similar questions to issues #12 and #13. Uncertain how best to test this feature (or the application).

It is not clear what the range might be for how many IGSN records per page, and therefore an upper limit on number of pages.

Tested using variations of limits of 10, 100, and 500. And pagenum of 1, 100, 20000. Tests are successful.

Test fails with limit 800 and pagenum of 10000. May not be significant, see note above. But goes to the limits.

Example export response_1591046213427_15.txt

lulin-song commented 4 years ago

"It is not clear what the range might be for how many IGSN records per page, and therefore an upper limit on number of pages." This can be calculated from total number from the other REST API #11, #14. The limit is chosen by the user according to the need.

lulin-song commented 4 years ago

"Test fails with limit 800 and pagenum of 10000." This is expected since it is exceeded its maximum.

ramdeensarah commented 4 years ago

Suggested changes to text to clarify purpose I did some reading about 'paginated' results to better understand the concept (and to figure out what is standard terminology, etc.). I want to suggest the following:

  1. Replace "GET/v1/rootigsns/sampletype Get published top level IGSNs with sample type. It is paginated." with "Get published top level IGSNs with sample type. It is paginated. Maximum number of IGSNs per page is 50,000".
  2. Replace description for limit "total number of IGSN to be returned" with "total number of IGSN to be returned per page"
  3. Leave description for pagenum as listed, "page number, E.G. 121 page".