Provides types and functions for interacting with a Wallabag server API.
See the documentation for usage information.
All API endpoints are implemented except for the /api/*/list{,s}. I don't
plan on implementing support for those unless there is a good reason to.
/api/annotations/{annotation}.{_format}
Removes an annotation./api/annotations/{annotation}.{_format}
Updates an annotation./api/annotations/{entry}.{_format}
Retrieve annotations for an entry./api/annotations/{entry}.{_format}
Creates a new annotation./api/entries.{_format}
Retrieve all entries. It could be filtered by many options./api/entries.{_format}
Create an entry./api/entries/exists.{_format}
Check if an entry exist by url./api/entries/list.{_format}
Handles an entries list and delete URL./api/entries/lists.{_format}
Handles an entries list and create URL./api/entries/tags/list.{_format}
Handles an entries list delete tags from them./api/entries/tags/lists.{_format}
Handles an entries list and add tags to them./api/entries/{entry}.{_format}
Delete permanently an entry./api/entries/{entry}.{_format}
Retrieve a single entry./api/entries/{entry}.{_format}
Change several properties of an entry./api/entries/{entry}/export.{_format}
Retrieve a single entry as a predefined format./api/entries/{entry}/reload.{_format}
Reload an entry./api/entries/{entry}/tags.{_format}
Retrieve all tags for an entry./api/entries/{entry}/tags.{_format}
Add one or more tags to an entry./api/entries/{entry}/tags/{tag}.{_format}
Permanently remove one tag for an entry./api/tag/label.{_format}
Permanently remove one tag from every entry by passing the Tag label./api/tags.{_format}
Retrieve all tags./api/tags/label.{_format}
Permanently remove some tags from every entry./api/tags/{tag}.{_format}
Permanently remove one tag from every entry by passing the Tag ID./api/user.{_format}
Retrieve current logged in user informations./api/user.{_format}
Register an user and create a client./api/version.{_format}
Retrieve version number.A few small examples are provided. To use these, the following environment variables must be set (for authentication). For example:
sh
export WALLABAG_CLIENT_ID="client_id"
export WALLABAG_CLIENT_SECRET="client_secret"
export WALLABAG_USERNAME="username"
export WALLABAG_PASSWORD="password"
export WALLABAG_URL="https://framabag.org" # must not end with trailing slash
The examples include:
Licensed under either of
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.