1
1
Fork 0
mirror of https://code.mensbeam.com/MensBeam/Arsse.git synced 2025-04-21 04:45:50 +00:00

Update documentation for NCNv1-3

This commit is contained in:
J. King 2025-03-03 09:10:54 -05:00
parent 76e753c253
commit a3b1b7128b
2 changed files with 9 additions and 1 deletions
CHANGELOG
docs/en/030_Supported_Protocols

View file

@ -1,3 +1,9 @@
Version 0.11.0 (2025-03-??)
===========================
New Features:
- Support for version 1.3 of the Nextcloud News protocol
Version 0.10.6 (2024-12-27)
===========================

View file

@ -9,8 +9,10 @@
<dd>/</dd>
<dt>API endpoint</dt>
<dd>/index.php/apps/news/api/v1-2/</dd>
<dd>/index.php/apps/news/api/v1-3/</dd>
<dt>Specifications</dt>
<dd><a href="https://github.com/nextcloud/news/blob/master/docs/api/api-v1-2.md">Version 1.2</a></dd>
<dd><a href="https://github.com/nextcloud/news/blob/master/docs/api/api-v1-3.md">Version 1.3</a></dd>
</dl>
The Nextcloud News protocol was the first supported by The Arsse, and has been supported in full since version 0.3.0.
@ -21,7 +23,7 @@ It allows organizing newsfeeds into single-level folders, and supports a wide ra
- Article GUID hashes are not hashes like in NCN; they are integers rendered as strings
- Article fingerprints are a combination of hashes rather than a single hash
- When marking articles as starred the feed ID is ignored, as they are not needed to establish uniqueness
- When marking articles as starred the feed ID is ignored, as they are not needed to establish uniqueness (v1.2 only)
- The feed updater ignores the `userId` parameter: feeds in The Arsse are deduplicated, and have no owner
- The `/feeds/all` route lists only feeds which should be checked for updates, and it also returns all `userId` attributes as empty strings: feeds in The Arsse are deduplicated, and have no owner
- The "updater" console commands mentioned in the protocol specification are not implemented, as The Arsse does not implement the required Nextcloud subsystems