docs: clarify use of PinStatus.id #47
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- `/pins/{cid-of-pin-object}` can be confusing,
because of `cid` is present in `PinStatus.Pin.cid`
- `/pins/{id}` has a clear connection to `PinStatus.id`
and a lower cognitive overhead
Clarified PinStatus.id description, as it proved to be vague when discussing it with people.
|
Merging in preparation for v0.0.5, will check copy in bulk before tagging the release. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR does not change the spec, it simplifies docs related to
/pinsendpoint/pins/{cid-of-pin-object}can be confusing because we meanPinStatus.id, but a field namedcidis present inPinStatus.Pin.cid/pins/{id}has a clear connection toPinStatus.idand 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