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

Create an API #318

Closed
17 tasks done
Jenselme opened this issue Nov 23, 2024 · 0 comments · Fixed by #322
Closed
17 tasks done

Create an API #318

Jenselme opened this issue Nov 23, 2024 · 0 comments · Fixed by #322
Assignees
Labels
enhancement New feature or request

Comments

@Jenselme
Copy link
Owner

Jenselme commented Nov 23, 2024

It’s kind of required for #156 We could rely on the existing code used by the app, but we will have CSRF issues by default and the user must be logged in the app (no idea how the login form could behave with an extension (and with MFA) and we don’t want to store passwords in the configuration of the extension). So this requires an ADR and some experimentation to see how hard it is to build the api.

In the long run, it’s a valuable addition to help users automate things. We won’t try to make an API follow an existing one (like the one from TTRSS) for now.

We need to be able to:

  • Subscribe to feeds.
  • For each subscribed feed, we want to:
    • Change the tags associated with it.
    • Change the category.
    • Delete the feed.
  • Save articles.
  • For a saved article, we want to:
    • Change the tags associated with it.
    • Mark it as read, favorite or for later.
    • Correct the title.
    • Correct the reading time.
    • Delete the article.
  • List all feeds with pagination.
  • List all feed categories with pagination.
  • Create a feed category.
  • Update a feed category.
  • Delete a feed category.

We target what we need for the browser extension for now. We will improve the API later in #320

@Jenselme Jenselme added the enhancement New feature or request label Nov 23, 2024
@Jenselme Jenselme added this to the December 2024 milestone milestone Nov 23, 2024
@Jenselme Jenselme self-assigned this Nov 23, 2024
Jenselme added a commit that referenced this issue Nov 24, 2024
We can list articles.

See #318
Jenselme added a commit that referenced this issue Nov 24, 2024
Jenselme added a commit that referenced this issue Nov 24, 2024
Jenselme added a commit that referenced this issue Nov 24, 2024
We also correct some behaviors.

See #318
Jenselme added a commit that referenced this issue Nov 24, 2024
@Jenselme Jenselme mentioned this issue Nov 26, 2024
Jenselme added a commit that referenced this issue Nov 28, 2024
We can list articles.

See #318
Jenselme added a commit that referenced this issue Nov 28, 2024
Jenselme added a commit that referenced this issue Nov 28, 2024
Jenselme added a commit that referenced this issue Nov 28, 2024
We also correct some behaviors.

See #318
Jenselme added a commit that referenced this issue Nov 28, 2024
Jenselme added a commit that referenced this issue Nov 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant