812091 - Define a "Quota Exceeded" error response for sync2.0

Status: RESOLVED FIXED

(Cloud Services Graveyard :: Server: Sync, defect)

Description

[Ryan Kelly [:rfkelly]]

The new error format defined in Bug 784592 currently has no way of reporting "user has exceeded their quota".  This seems similar to the upgrade-required error condition, in that it's an error state the perfectly-implemented clients will still have to detect and deal with.

Therefore, it seems like we should define another top-level status for this state and have the error response body be:

  { status: "quota-exceeded" }


Alternatively we could use HTTP "507 Insufficient Storage" as defined by WebDAV (RFC 4918), but I vaguely recall a client team objection to using WebDAV's custom status codes..?

Comment 1

[Ryan Kelly [:rfkelly]]

Attachment: docs patch defining "quota-exceeded" response

Here's a concrete proposal using "403 Forbidden" with an error status field of "quota-exceeded".

A 403 seemed more appropriate than a 400 since there's nothing actually wrong with the request, we are just "refusing to fulfil it for reasons other than invalid credentials".

Comment 2

[Ryan Kelly [:rfkelly]]

https://github.com/mozilla-services/docs/commit/b6e9ac0213f2b094a8dad54db2c0fc6470ba3d9c

Comment 3

[Ryan Kelly [:rfkelly]]

Implemented in the big cornice-format-errors refactor of Bug 812432.