internetarchive / internetarchive/openlibrary

Create an api for user Notes

Open
#9,872 3 comments 2 reactions 0 assignees View on GitHub
Lead: @jimchamp Needs: Breakdown Priority: 3 State: Blocked Type: Feature Request
Dominant language
Python
Stars
6.7k
Forks
2k
Avg merge
2d 19h
Merged PRs (30d)
138

Description

### Proposal

I would like an API to be exposed to read and write user notes for books.

### Justification

This would be be a nice feature for people to build third party clients on or allow savvy users to modify their notes easily.

Personally, I would like to build a prototype of a UI to easily search and edit notes across many books so that's why I'm requesting this.

Honestly, most likely the impact is small. But you never know what someone might build with it.

### Breakdown

#### Requirements Checklist

* [ ] An API to read a user's notes
* [ ] An API to write notes for a user
* [ ] Both should be behind user auth

#### Related files

*Unsure

#### Stakeholders

*


#### Instructions for Contributors

Please [run these commands](https://github.com/internetarchive/openlibrary/wiki/Git-Cheat-Sheet#working-on-your-branch) to ensure your repository is up to date **before** [creating a new branch](https://github.com/internetarchive/openlibrary/wiki/Git-Cheat-Sheet#making-changes-and-creating-a-pull-request) to work on this issue and **each time after** pushing code to Github, because the pre-commit bot may add commits to your PRs upstream.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.