web3.storage icon indicating copy to clipboard operation
web3.storage copied to clipboard

PSA GET /pin documentation incomplete

Open dchoi27 opened this issue 2 years ago • 1 comments

Documentation on https://web3.storage/docs/how-tos/pinning-services-api/#list-successful-pins is incomplete. Per https://github.com/web3-storage/web3.storage/issues/1981#issuecomment-1276318231, you need to pass a query param to get the type of pin you're looking to query for (e.g. ?status=pinned), but the documentation doesn't include this.

@mbommerez could someone on the team update this when they have the chance?

dchoi27 avatar Oct 20 '22 03:10 dchoi27

@dchoi27 There has been a lot of discussion around this status being mandatory or not in the filter. We have a PR waiting to be deployed that will change this behaviour. Will add this to our queue to have a look once all of that is live if our docs match the current behaviour. CC @flea89

mbommerez avatar Dec 01 '22 11:12 mbommerez