ipfs / pinning-services-api-spec

Standalone, vendor-agnostic Pinning Service API for IPFS ecosystem
https://ipfs.github.io/pinning-services-api-spec/
Creative Commons Zero v1.0 Universal
100 stars 27 forks source link

Provide documented examples of queries / the patterns for them #54

Closed obo20 closed 3 years ago

obo20 commented 3 years ago

We need to let implementers of this spec know how to format their queries, specifically when dealing with things like arrays.

As threads like this show: https://stackoverflow.com/questions/11944410/passing-array-in-get-for-a-rest-call

There are many many ways you can do arrays for rest queries. @lidel has told me we've opted to go with the status=pinning,pinned formatting which I think makes sense. However we should definitely document this outside of the YAML for those who are reading the spec from their browser.