Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Announcement: Breaking changes in 15.1.0 #939

Closed
3 tasks done
Grotax opened this issue Nov 11, 2020 · 6 comments
Closed
3 tasks done

Announcement: Breaking changes in 15.1.0 #939

Grotax opened this issue Nov 11, 2020 · 6 comments

Comments

@Grotax
Copy link
Member

Grotax commented Nov 11, 2020

IMPORTANT

Read and tick the following checkbox after you have created the issue or place an x inside the brackets ;)

  • I have read the CONTRIBUTING.md and followed the provided tips
  • I accept that the issue will be closed without comment if I do not check here
  • I accept that the issue will be closed without comment if I don not fill out all items in the issue template.

Explain the Problem

With News 15.1.0 the feed attribute "folderId" will no longer be 0 if the feed is in the root folder the new value is null.
This change is needed to improve the code and data structure.

Endpoint: https://yournextcloud.com/index.php/apps/news/api/v1-2/feeds
See this example:

 "feeds": [
    {
      "id": 3,
      "url": "https://krebsonsecurity.com/feed/",
      "title": "Krebs on Security",
      "faviconLink": "https://krebsonsecurity.com/favicon.ico",
      "added": 1490999780,
      "folderId": null,
      "unreadCount": 1,
      "ordering": 0,
      "link": "https://krebsonsecurity.com/",
      "pinned": false,
      "updateErrorCount": 0,
      "lastUpdateError": null,
      "items": []
    },
....
]

Solution

The suggested solution is to allow both "0" and "null" in your client to allow for a smooth transition.

@martinrotter
Copy link

Does the change affect "createFeed" API method too?

@anoymouserver
Copy link
Contributor

anoymouserver commented Nov 12, 2020

Create feed (POST /feeds) currently allows null and 0 but it would be better to use null for the future, so that it's consistent.

Same for moving feeds to a different folder (PUT /feeds/{feedId}/move) and marking items of a folder as read (PUT /folders/{folderId}/read).

I've updated the docs accordingly: API v1-2

@phedlund
Copy link
Contributor

Can I count on 0 not being used for a folder other than root in the future? That is, can my client continue to use 0 internally for the root folder?

@SMillerDev
Copy link
Contributor

Could you make a feature request for this? It sounds reasonable but I'm not sure if it'll happen right now.

@SMillerDev
Copy link
Contributor

Can I count on 0 not being used for a folder other than root in the future? That is, can my client continue to use 0 internally for the root folder?

You can, the IDs start at 1.

@Grotax
Copy link
Member Author

Grotax commented Dec 8, 2020

@Grotax Grotax closed this as completed Dec 8, 2020
@Grotax Grotax unpinned this issue Dec 8, 2020
@Grotax Grotax pinned this issue Dec 8, 2020
@Grotax Grotax unpinned this issue Jan 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants