hydrusnetwork / hydrusnetwork/hydrus
Meta: Client API feature request summary
Open
Nobody has claimed this yet.
dev-notified
not-actionable
- Dominant language
- Python
- Stars
- 3.2k
- Forks
- 207
- PR merge metrics
- No merged PRs in 30d
Description
This is a meta issue that summarizes all the current API related feature requests and attempts to organize them and give some extra commentary. I plan to update this issue with new requests and when existing ones are closed.
File Metadata
- Client API: Change Archive/Inbox and Trash state for files #393
- This seems fairly simple and would be very useful immediately for a number of existing uses of the API.
- Use BlurHash in Hydrus #394
- Client API: notes #346
- This would probably involve being able to (perhaps optionally) get the notes of a file through the metadata API or a separate API and another API for setting the notes on a file.
- Client API: more file metadata #345
- Time imported and whatever other metadata is not currently returned by the file_metadata endpoint
- May need to be behind another query parameter for performance if some metadata needs to be calculated before being returned.
Search
- Client API: searching via system predicates #351
- Basic system predicates
- sorting
- Sorting in API search #236
- Client API: Search wildcards #654
- Support for OR Logic Conditions in Client API #854
- Client API: /get_files/search_files - Return quantity instead of list of files #934
- Client API: tag search autocomplete #958
- Client API: Sort by tag namespace #1062
Pages
- Client API: page and query management #350
- API: Change page contents #570
- adding files to pages has been implemented
- Client API: endpoint to refresh a page #944
Tags
- Expose favourite tags via API #311
- Client API: tags with use counts per service #359
- Client API: read/write tag presentation details #360
- Client API: Apply siblings on retrieved tags #389
- Additional Option for the API Settings to not Allow Overwriting Previosly Deleted Tags #660
- Client API: Query Tag Parent/Child Relationships #921
- Client API: add/edit/remove parents/siblings #1077
URLs
- Feature:API:Search URLs by prefix #240
- Client API: Ability to lookup an array of URLs in
get_url_infoandget_url_files#655 - Client API: Associate Additional URLs with add_url Endpoint #1059
Other
- Client API: get information about services #342
- Client API: subscriptions #344
- Client API: ratings #343
- Client API: alternates/duplicates #347
- Generate QR codes for Apps #237
- Client API: manage headers (like cookies) #349
- Add DB Lock feature to the Client side #333
- Popup notification for when things are added through API #559
- Cache for API requests #605
- Support for HTTP 206 Partial Content for audio / video seeking on the client api #647
- RfE: add a root-certificate to the hydrus api https process w/ user input fields for ip and dns names #675
- Notifications API #743
- Client API request proxy #899
- Client API: Read Main Gui Title #916
- Client API: Allow browsers to cache CORS preflight requests #935
- Manage shortcuts/keybinds through API #1012
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the unchecked Client API requests listed in this issue and follow their linked issues for implementation scope. This is a tracking summary rather than a self-contained implementation task; done means updating its checklist as requests are completed.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 15/100