nextcloud / nextcloud/server

Support ETags for /ocs/v2.php/cloud/users/{userId} endpoint (or all ocs endpoints?)

Open
#26,947 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

1. to develop client: 🤖🍏 mobile enhancement performance 🚀 technical debt
Dominant language
PHP
Stars
36.9k
Forks
5.2k
Avg merge
2d 3h
Merged PRs (30d)
713

Description

How to use GitHub
  • Please use the 👍 reaction to show that you are interested into the same feature.
  • Please don't comment if you have no relevant information to add. It's just extra noise for everyone subscribed to this issue.
  • Subscribe to receive notifications on status change and new comments.

Is your feature request related to a problem? Please describe.
Motivation is to keep the transmitted data traffic from clients to the server as low as possible for 1. a better performance and 2. to preserve mobile traffic

Describe the solution you'd like
Support ETags in all ocs endpoints by default, but i will already be happy if this endpoint supports it:
/ocs/v2.php/cloud/users/{userId}

Describe alternatives you've considered
Not implementing human readable display names but technical user IDs because it's not worth the traffic without ETags in the Notes app.

Additional context
Some time ago someone already implemented this for the capabilities endpoint, maybe it's just a bit copy & paste...

cc @nickvergessen who pointed me here: https://github.com/nextcloud/notifications/blob/5ac74461141d8992bf1fb22c6e5fabf0544e5db1/lib/Controller/EndpointController.php#L128

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by comparing the implementation referenced in notifications/lib/Controller/EndpointController.php around line 128 with the server OCS users endpoint at /ocs/v2.php/cloud/users/{userId}. Determine whether the change should cover that endpoint or all OCS endpoints; done means the selected endpoint(s) support ETags and avoid transmitting unchanged data.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.