Closed lidel closed 4 years ago
This PR does not change the spec, it simplifies docs related to /pins endpoint
/pins
/pins/{cid-of-pin-object}
PinStatus.id
cid
PinStatus.Pin.cid
/pins/{id}
Preview: https://ipfs.github.io/pinning-services-api-spec/#specUrl=https://raw.githubusercontent.com/ipfs/pinning-services-api-spec/docs/clarify-object-id/ipfs-pinning-service.yaml
Merging in preparation for v0.0.5, will check copy in bulk before tagging the release.
This PR does not change the spec, it simplifies docs related to
/pins
endpoint/pins/{cid-of-pin-object}
can be confusing because we meanPinStatus.id
, but a field namedcid
is present inPinStatus.Pin.cid
/pins/{id}
has a clear connection toPinStatus.id
and reduces cognitive overheadPreview: https://ipfs.github.io/pinning-services-api-spec/#specUrl=https://raw.githubusercontent.com/ipfs/pinning-services-api-spec/docs/clarify-object-id/ipfs-pinning-service.yaml