hvdsomp / signposting

8 stars 0 forks source link

Document Holofood signposting #34

Closed stain closed 1 month ago

stain commented 1 month ago

https://www.holofooddata.org/ is a registry of samples and data collected for Hologenomics for sustainable food production. Signposting is used to provide a link from HTML landing page to its corresponding REST API as JSON, with a OpenAPI indicated as its profile.

This is an example of minimal signposting, when no FAIR formats are available yet.

$ signposting https://www.holofooddata.org/sample/SAMEA10104908
Signposting for https://www.holofooddata.org/sample/SAMEA10104908 
Collection: <https://www.holofooddata.org/api/samples>
DescribedBy: <https://www.holofooddata.org/api/samples/SAMEA10104908> application/json
$ curl --head https://www.holofooddata.org/sample/SAMEA10104908 | grep Link

Link: <https://www.holofooddata.org/api/samples/SAMEA10104908> ; 
    rel="describedBy" ; type="application/json" ; profile="https://www.holofooddata.org/api/openapi.json", 
Link: <https://www.holofooddata.org/api/samples> ; 
   rel="collection" ; type="application/json" ; profile="https://www.holofooddata.org/api/openapi.json"

Contact @SandyRogers for any questions/improvements.

hvdsomp commented 1 month ago

They got their describedby wrong. They use describedBy instead. @stain can you inform them?

hvdsomp commented 1 month ago

@SandyRogers Your Link header implementation uses describedBy instead of describedby as a link relation type. The latter one is registered in the IANA Link Relation Registry and used in FAIR Signposting.

hvdsomp commented 1 month ago

Added entry for the Holofood portal at https://signposting.org/adopters/#holofood

SandyRogers commented 1 month ago

@hvdsomp Thanks - fixed by https://github.com/EBI-Metagenomics/holofood-database/commit/28707e24827440b2c50eda0fe3baa17852cf02d8