API ContractsHTTP contracts

api-contracts/no-misleading-http-status

Explicit HTTP status exits should agree with the route's visible result while allowing accepted work and deliberate protocol or privacy contracts.

httpstatus-codesroutes

01 Examples

TypeScript

app.post("/users", async (_req, res) => { await createUser(); res.sendStatus(404); });

Finding

Disallow statuses that contradict visible outcomes.

02 Enable it

Setup

Install the package, register its plugin factory, then enable the rule.

pnpm add -D @scruple/api-contracts

In scruple.config.ts, register the factory under the api-contracts namespace used by the rule ID.

import { apiContracts } from "@scruple/api-contracts";

plugins: {
  "api-contracts": apiContracts(),
},

"api-contracts/no-misleading-http-status": "warn"