search

PRIDE-Archive / xi-mzidentml-converter

Apache License 2.0
0 stars 0 forks source link

Request a correction on URL #58

Closed sureshhewabi closed 4 months ago

sureshhewabi commented 4 months ago

/pride/ws/archive/crosslinking/pdbdev/projects/PXD036833/residue-pairs/based-on-reported-psm-level/passing?page=1&page_size=10

As there are no resource pointed for /pride/ws/archive/crosslinking/pdbdev/projects/PXD036833/residue-pairs/ I would suggest to change the above API URIs as following:

/pride/ws/archive/crosslinking/pdbdev/projects/PXD036833/residue-pairs?threshold=passing&page=1&page_size=10 where default value of threshold could be all

The key abstraction of information in REST is a resource. Any information that can be named can be a resource... Read More: https://restfulapi.net/resource-naming/

colin-combe commented 4 months ago

i think leave it, the /based-on-reported-psm-level part is there because in the future there might be other bases for residue pair info. So that extra part is there so that uRL's don't need to change in future if we introduce more end points. That was the idea anyway.

You might be right about the threshold/passing parameter.

colin-combe commented 4 months ago

The key abstraction of information in REST is a resource. Any information that can be named can be a resource... Read More: https://restfulapi.net/resource-naming/

thanks for this info

sureshhewabi commented 4 months ago

Noted. Thanks!