registry.rec (6922B)
1 # -*- mode: rec -*- 2 # 3 # Registry for Beekeeper error codes 4 # 5 # Beekeeper (JSON forms and KYC media collection) returns these codes in 6 # the "code" field of its error responses, next to the generic codes 7 # (0-99) of the GNU Taler registry, which it uses for errors of the HTTP 8 # framework. Its values are kept apart from the Taler registry (0-9999) 9 # so that the two can never clash. 10 # 11 %rec: BeekeeperErrorCode 12 %key: Value 13 %singular: Value 14 %typedef: ValueRange_t range 100000 110000 15 %type: Value ValueRange_t 16 %mandatory: Value 17 %typedef: Description_t regexp |^[abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_-][abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789_\(\)\.,;!"':#`\/ -]*$| 18 %type: Description Description_t 19 %mandatory: Description 20 %typedef: Name_t regexp /^BEEKEEPER_[ABCDEFGHIJKLMNOPQRSTUVWXYZ_0123456789]*$/ 21 %type: Name Name_t 22 %unique: Name 23 %mandatory: Name 24 %singular: Name 25 %type: HttpStatus rec HttpStatusCode 26 %mandatory: HttpStatus 27 %sort: Value 28 29 # 100000 - 100099: generic 30 31 Value: 100000 32 Name: BEEKEEPER_RATE_LIMITED 33 Description: Too many requests of this kind from this client. Retry after the time given in the Retry-After header. 34 HttpStatus: 429 35 36 Value: 100001 37 Name: BEEKEEPER_PROOF_OF_WORK_INVALID 38 Description: The server requires a proof of work for this request, and it was missing, wrong or expired. Fetch a new puzzle and retry. 39 HttpStatus: 403 40 41 # 100100 - 100199: authentication 42 43 Value: 100100 44 Name: BEEKEEPER_ACCESS_TOKEN_UNKNOWN 45 Description: The access token of the personal link is unknown or was revoked, for example because a new link was issued. 46 HttpStatus: 401 47 48 Value: 100101 49 Name: BEEKEEPER_SESSION_INVALID 50 Description: The session token is missing, expired or revoked. Create a new session. 51 HttpStatus: 401 52 53 Value: 100102 54 Name: BEEKEEPER_OTP_WRONG 55 Description: The one-time code is wrong. 56 HttpStatus: 403 57 58 Value: 100103 59 Name: BEEKEEPER_OTP_EXPIRED 60 Description: The one-time code has expired or has no attempts left. Request a new one. 61 HttpStatus: 409 62 63 Value: 100104 64 Name: BEEKEEPER_ADMIN_LOGIN_FAILED 65 Description: The user name, password or TOTP code is wrong. 66 HttpStatus: 401 67 68 Value: 100105 69 Name: BEEKEEPER_ADMIN_ROLE_MISSING 70 Description: The administrator account lacks the role required for this request. 71 HttpStatus: 403 72 73 # 100200 - 100299: forms 74 75 Value: 100200 76 Name: BEEKEEPER_FORM_UNKNOWN 77 Description: There is no such form, or it is not public. 78 HttpStatus: 404 79 80 Value: 100201 81 Name: BEEKEEPER_FORM_INVALID 82 Description: The form definition failed the static checks. The problems are listed per JSON path. 83 HttpStatus: 400 84 85 Value: 100202 86 Name: BEEKEEPER_FORM_RETIRED 87 Description: The form was retired and can no longer be assigned or started. 88 HttpStatus: 409 89 90 # 100300 - 100399: users, assignments and pages 91 92 Value: 100300 93 Name: BEEKEEPER_ASSIGNMENT_UNKNOWN 94 Description: There is no such assignment for this user. 95 HttpStatus: 404 96 97 Value: 100301 98 Name: BEEKEEPER_ASSIGNMENT_STATE 99 Description: The request is not allowed in the current state of the assignment. 100 HttpStatus: 409 101 102 Value: 100302 103 Name: BEEKEEPER_ASSIGNMENT_INCOMPLETE 104 Description: The assignment cannot be submitted because some visible pages do not pass their checks. 105 HttpStatus: 400 106 107 Value: 100303 108 Name: BEEKEEPER_PAGE_UNKNOWN 109 Description: The form has no page with this identifier. 110 HttpStatus: 404 111 112 Value: 100304 113 Name: BEEKEEPER_PAGE_HIDDEN 114 Description: The page is not visible with the current answers. 115 HttpStatus: 409 116 117 Value: 100305 118 Name: BEEKEEPER_PAGE_INVALID 119 Description: The answers were saved as a draft, but the page did not pass its checks. The problems are listed per question. 120 HttpStatus: 400 121 122 Value: 100306 123 Name: BEEKEEPER_QUESTION_UNKNOWN 124 Description: There is no such question on this page, or it does not support the requested operation. 125 HttpStatus: 404 126 127 Value: 100307 128 Name: BEEKEEPER_USER_UNKNOWN 129 Description: There is no such user. 130 HttpStatus: 404 131 132 # 100400 - 100499: verification of contact data 133 134 Value: 100400 135 Name: BEEKEEPER_VERIFICATION_WRONG_CODE 136 Description: The verification code is wrong. 137 HttpStatus: 403 138 139 Value: 100401 140 Name: BEEKEEPER_VERIFICATION_RATE_LIMITED 141 Description: Verification codes were requested too often for this user or address. 142 HttpStatus: 429 143 144 Value: 100402 145 Name: BEEKEEPER_VERIFICATION_NOT_STARTED 146 Description: No verification code was sent for the current answer, or it has expired. 147 HttpStatus: 409 148 149 Value: 100403 150 Name: BEEKEEPER_HELPER_FAILED 151 Description: The helper program that delivers e-mail, SMS or letters failed. 152 HttpStatus: 502 153 154 # 100500 - 100599: uploads, blobs and video challenges 155 156 Value: 100500 157 Name: BEEKEEPER_CHALLENGE_EXPIRED 158 Description: The recording answers a video challenge that has expired or was replaced by a newer one. 159 HttpStatus: 409 160 161 Value: 100501 162 Name: BEEKEEPER_BLOB_UNKNOWN 163 Description: An answer refers to a file that this user has not uploaded. 164 HttpStatus: 400 165 166 Value: 100502 167 Name: BEEKEEPER_BLOB_NOT_FOUND 168 Description: There is no such file. 169 HttpStatus: 404 170 171 Value: 100503 172 Name: BEEKEEPER_UPLOAD_TOO_LARGE 173 Description: The upload is larger than the question or the server allows. 174 HttpStatus: 413 175 176 Value: 100504 177 Name: BEEKEEPER_UPLOAD_TYPE 178 Description: The question does not accept files of this MIME type. 179 HttpStatus: 415 180 181 Value: 100505 182 Name: BEEKEEPER_UPLOAD_UNKNOWN 183 Description: There is no such upload, or it has expired. 184 HttpStatus: 404 185 186 Value: 100506 187 Name: BEEKEEPER_UPLOAD_OFFSET_MISMATCH 188 Description: The Upload-Offset of the request does not match the length received so far. 189 HttpStatus: 409 190 191 Value: 100507 192 Name: BEEKEEPER_UPLOAD_CHECKSUM_MISMATCH 193 Description: The SHA-256 of the complete upload differs from the announced one, and the upload was discarded. The tus endpoint answers with its status 460 (Checksum Mismatch), which the HTTP status registry does not list. 194 HttpStatus: 409 195 196 Value: 100508 197 Name: BEEKEEPER_SUBTITLES_INVALID 198 Description: The subtitles of a challenge recording are not a well-formed SRT file, or their cues do not match the actions, order, timing and instructions of the challenge. 199 HttpStatus: 400 200 201 Value: 100600 202 Name: BEEKEEPER_OAUTH_CLIENT_UNKNOWN 203 Description: The OAuth2 client is unknown or disabled, or its secret is wrong. 204 HttpStatus: 401 205 206 Value: 100601 207 Name: BEEKEEPER_OAUTH_PROCESS_UNKNOWN 208 Description: There is no such KYC process, or it has expired. 209 HttpStatus: 404 210 211 Value: 100602 212 Name: BEEKEEPER_OAUTH_REQUEST_INVALID 213 Description: The authorization request does not match the client: wrong client_id, redirect_uri or response_type. 214 HttpStatus: 400 215 216 Value: 100603 217 Name: BEEKEEPER_OAUTH_CODE_INVALID 218 Description: The authorization code is unknown, expired or was already used. 219 HttpStatus: 403 220 221 Value: 100604 222 Name: BEEKEEPER_OAUTH_TOKEN_INVALID 223 Description: The access token is unknown or expired. 224 HttpStatus: 401 225 226 Value: 100605 227 Name: BEEKEEPER_OAUTH_NOT_READY 228 Description: The KYC process is not finished yet: some assignments are neither accepted nor failed. 229 HttpStatus: 409