buildingSMART / documents-API

part of the openCDE portfolio
22 stars 2 forks source link

Indicate breach of polling frequency limit #31

Closed oogali closed 1 year ago

oogali commented 2 years ago

Currently, it's undefined how a server will behave it receives too many polling requests in a given period. As a result, a client may continue to blindly retry (or worse, stop polling altogether).

Would it be out of the question to codify into the specification that if a server should respond with 429 Too Many Requests[1] if/when it decides that it has received too many polling requests from the client?

That specific response code would allow client implementations to understand what has gone wrong and to take corrective actions to reduce its impact: whether that action would be to go into a slower polling interval, reduce the number of documents that it's attempting to poll for in a single request, or simply notify the end user.

1: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429