docs: clarify use of provider hints

ipfs / pinning-services-api-spec

Standalone, vendor-agnostic Pinning Service API for IPFS ecosystem

Creative Commons Zero v1.0 Universal

99 stars 26 forks source link

Closed lidel closed 3 years ago

lidel commented 3 years ago

This PR updates docs and examples related to origins and delegates multiaddr arrays:

makes it explicit that connection dials to origins and delegates are best-effort, and should not fail the pinning
swaps examples to use fully resolved multiaddrs, that can immediately be acted upon (IPs from test ranges defined in rfc5737)

Thanks to @obo20 for raising the ambiguity here – lmk if this clears things out.

lidel commented 3 years ago

@jessicaschilling thank you, applied suggestions + made a small clarification in https://github.com/ipfs/pinning-services-api-spec/pull/72/commits/84cec73670165160fa2e33bc550d587d492494ac – mind taking a second look?

lidel commented 3 years ago

Merging as I got :+1: from @aschmahmann and @obo20 via a telepathic medium of a great accuracy.