nextcloud / news

:newspaper: RSS/Atom feed reader
https://apps.nextcloud.com/apps/news
GNU Affero General Public License v3.0
863 stars 186 forks source link

API specification (v2) does not document fullTextEnabled #102

Open JKingweb opened 7 years ago

JKingweb commented 7 years ago

IMPORTANT

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

Explain the Problem

The API specification for the v2 API does not document what the 'fullTextEnabled' feed property means. The method docs say only "see Feeds", but the Feeds section does not document the property.

I gather (after reading CONTRIBUTING :) ) that this is about PicoFeed full-content scraping rather than full-text searching as I had first assumed, but even knowing this it's not clear how it should/can be used.

--- Want to back this issue? **[Post a bounty on it!](https://www.bountysource.com/issues/42462849-api-specification-v2-does-not-document-fulltextenabled?utm_campaign=plugin&utm_content=tracker%2F38605310&utm_medium=issues&utm_source=github)** We accept bounties via [Bountysource](https://www.bountysource.com/?utm_campaign=plugin&utm_content=tracker%2F38605310&utm_medium=issues&utm_source=github).
BernhardPosselt commented 7 years ago

Can you create a pull request in that case? It's still a draft BTW nothing is implemented yet

JKingweb commented 7 years ago

As I'm not sure what the spec should be saying on the subject, I don't think it would make sense for me to create a pull request.

The 10.0.0 changelog suggests a new update API is now in use. I took that to mean the v2 API had been implemented; is that not the case, then? I've not looked at the software yet; I've just been reading the specs.

BernhardPosselt commented 7 years ago

Yeah, misunderstanding :) that one was about cron job updates which had to be done because the old APIs were removed.

There's an api call that lists available APIs which you can query.

The full text enabled basically turns on full text feeds from picofeed as in: the target website still be parsed and not the RSS entry

Thaodan commented 1 year ago

The full text enabled basically turns on full text feeds from picofeed as in: the target website still be parsed and not the RSS entry

I think it makes sense to mention that some feeds already have the full contents of the website for that entry. In such cases there should be some feedback for the user.

Does this also affects clients that fetch feeds from the nextcloud app?

Grotax commented 1 year ago

API v2 is not even implemented yet.

But yes it would affect clients.

The api is currently only used by clients the web interface is not really using the api but other ways.

Thaodan commented 1 year ago

Benjamin Brahmer @.***> writes:

The api is currently only used by clients the web interface is not really using the api but other ways.

What does that mean? The web interface shows an option to enable this feature, this must mean that it is using Apiv2.

SMillerDev commented 1 year ago

What does that mean? The web interface shows an option to enable this feature, this must mean that it is using Apiv2.

No, quite the opposite. This issue says that there is no V2 api to enable full text.

Thaodan commented 1 year ago

Sean Molenaar @.***> writes:

No, quite the opposite. This issue says that there is no V2 api to enable full text.

Does the option to do nothing then?

Grotax commented 1 year ago

What I meant in my first comment was that the integrated web interface is not using the API that news provides to other clients.

Therefore functionality and features are different.

The webclient has the option to enable full text but it doesn't do that over a public API endpoint.

I hope that clears up some confusion.

External apps currently use API v1.2 or v1.3 which brought a few new options. v2 was only drafted years ago but never fully implemented.