monkeytypegame/monkeytype
1
1
Fork 0
mirror of https://github.com/monkeytypegame/monkeytype.git synced 2025-10-20 04:26:28 +08:00
Code Issues Projects Releases Packages Wiki Activity

impr: add custom error codes to contracts and api doc (@fehmer) (#6976)

Browse source
This commit is contained in:
Christian Fehmer 2025-09-19 18:59:46 +02:00 • committed by GitHub
parent 74e4dd7b2a
commit 5026f41954
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 12 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
packages/contracts/src/results.ts
View file

@ -3,6 +3,7 @@ import { z } from "zod";
import {
CommonResponses,
meta,
MonkeyClientError,
MonkeyResponseSchema,
responseWithData,
} from "./util/api";
@ -131,6 +132,13 @@ export const resultsContract = c.router(
body: AddResultRequestSchema.strict(),
responses: {
200: AddResultResponseSchema,
460: MonkeyClientError.describe("Test too short"),
461: MonkeyClientError.describe("Result hash invalid"),
462: MonkeyClientError.describe("Result spacing invalid"),
463: MonkeyClientError.describe("Result data invalid"),
464: MonkeyClientError.describe("Missing key data"),
465: MonkeyClientError.describe("Bot detected"),
466: MonkeyClientError.describe("Duplicate result"),
},
metadata: meta({
rateLimit: "resultsAdd",

4
packages/contracts/src/util/api.ts
View file

@ -120,6 +120,10 @@ export const CommonResponses = {
403: MonkeyClientError.describe("Operation not permitted"),
422: MonkeyValidationErrorSchema.describe("Request validation failed"),
429: MonkeyClientError.describe("Rate limit exceeded"),
470: MonkeyClientError.describe("Invalid ApeKey"),
471: MonkeyClientError.describe("ApeKey is inactive"),
472: MonkeyClientError.describe("ApeKey is malformed"),
479: MonkeyClientError.describe("ApeKey rate limit exceeded"),
500: MonkeyServerError.describe("Generic server error"),
503: MonkeyServerError.describe(
"Endpoint disabled or server is under maintenance"