Dispel NextCloud News ambiguities #139

New issue

Closed

opened 2018-11-07 10:05:27 -05:00 by jking · 1 comment

jking commented

2018-11-07 10:05:27 -05:00

Owner

The README file lists several unknown or unclear behaviours in the reference NCNv1 implementation, namely:

NCN specifies that GET parameters are treated "the same" as request body parameters; it does not specify what to do in cases where they conflict
JSON is preferred unconditionally
NCN does not define validity of folder and names other than to specify that the empty string is invalid
Any folder name other than the empty string appears to be accepted
NCN does not specify a return code for bulk-marking operations without a newestItemId provided
The operation fails silently
NCN does not specify what should be done when creating a feed in a folder which does not exist
The feed is created, but is inaccessible until moved to a real folder
NCN does not specify what should be done when moving a feed to a folder which does not exist
The feed becomes inaccessible until moved to a real folder
NCN does not specify what should be done when renaming a feed to an invalid title, nor what constitutes an invalid title
Feed titles are unrestricted

The actual behaviour of NextCloud News (or, in some cases, NextCloud at large), should be tested and The Arsse made to behave the same.

The README file lists several unknown or unclear behaviours in the reference NCNv1 implementation, namely: - NCN specifies that GET parameters are treated "the same" as request body parameters; it does not specify what to do in cases where they conflict - JSON is preferred unconditionally - NCN does not define validity of folder and names other than to specify that the empty string is invalid - Any folder name other than the empty string appears to be accepted - NCN does not specify a return code for bulk-marking operations without a `newestItemId` provided - The operation fails silently - NCN does not specify what should be done when creating a feed in a folder which does not exist - The feed is created, but is inaccessible until moved to a real folder - NCN does not specify what should be done when moving a feed to a folder which does not exist - The feed becomes inaccessible until moved to a real folder - NCN does not specify what should be done when renaming a feed to an invalid title, nor what constitutes an invalid title - Feed titles are unrestricted The actual behaviour of NextCloud News (or, in some cases, NextCloud at large), should be tested and The Arsse made to behave the same.

jking added this to the 0.5.0 milestone

2018-11-07 10:05:27 -05:00

jking added the

trivial

label

2018-11-07 10:05:27 -05:00

jking commented

2018-11-07 12:44:39 -05:00

Author

Owner

As some of the tested behaviour is nonsensical (viz. disappearing feeds) and other differences actually helpful (e.g. silently failing is bad, whitespace-only names leads to odd results), only the first point will result in a change in behaviour in The Arsse.

jking closed this issue

2018-11-07 13:02:15 -05:00