Document divergences from NCNv1 protocol #108

Closed
opened 7 years ago by jking · 0 comments
jking commented 7 years ago
Owner

While the NCNv1 protocol is fully supported insofar as all functionality is present, there do exist minor divergences from the protocol text:

  1. Article GUID hashes are not actually GUID hashes, though they achieve the same function
  2. Article fingerprints are not 64-character hashes, though they achieve the same purpose
  3. Some calls return HTTP error codes which are not outlined by the specification
  4. The implementation of underspecified behaviour (e.g. entity body data and query parameter data being treated "the same") may differ from the reference implementation
  5. Feeds don't have owners, which affects the update portion of the API

All of this should be properly documented in the readme/manual. Information should be available by combing issues and code comments.

While the NCNv1 protocol is fully supported insofar as all functionality is present, there do exist minor divergences from the protocol text: 1. Article GUID hashes are not actually GUID hashes, though they achieve the same function 2. Article fingerprints are not 64-character hashes, though they achieve the same purpose 3. Some calls return HTTP error codes which are not outlined by the specification 4. The implementation of underspecified behaviour (e.g. entity body data and query parameter data being treated "the same") may differ from the reference implementation 5. Feeds don't have owners, which affects the update portion of the API All of this should be properly documented in the readme/manual. Information should be available by combing issues and code comments.
jking added this to the 0.2.0 milestone 7 years ago
jking added the
documentation
label 7 years ago
jking referenced this issue from a commit 6 years ago
jking closed this issue 6 years ago
Sign in to join this conversation.
No Milestone
No Assignees
1 Participants
Notifications
Due Date

No due date set.

Dependencies

This issue currently doesn't have any dependencies.

Loading…
There is no content yet.