Skip to content

docs: add API key auth requirement to /ws/stats in OpenAPI spec#156

Open
0x-SquidSol wants to merge 1 commit intodcccrypto:mainfrom
0x-SquidSol:docs/openapi-ws-stats-auth
Open

docs: add API key auth requirement to /ws/stats in OpenAPI spec#156
0x-SquidSol wants to merge 1 commit intodcccrypto:mainfrom
0x-SquidSol:docs/openapi-ws-stats-auth

Conversation

@0x-SquidSol
Copy link
Copy Markdown
Contributor

Summary

  • Issue: GET /ws/stats requires x-api-key header via requireApiKey() middleware, but the OpenAPI spec had no security requirement. Clients following the spec would receive an undocumented 401.
  • Fix: Adds securitySchemes component and security + 401 response to the /ws/stats operation.

Changes

  • Added components.securitySchemes.ApiKeyAuth (apiKey in header, name: x-api-key)
  • Added security: [ApiKeyAuth: []] to /ws/stats GET operation
  • Added 401 response with example error message
  • Updated endpoint description to note auth requirement

Test plan

  • vitest run passes (186/186 tests)
  • Verified requireApiKey() checks x-api-key header in src/middleware/auth.ts

🤖 Generated with Claude Code

The /ws/stats endpoint applies requireApiKey() middleware (health.ts:76)
which checks the x-api-key header, but the OpenAPI spec had no security
requirement documented. Clients following the spec would hit an
undocumented 401.

Adds:
- securitySchemes.ApiKeyAuth component (apiKey in header, name: x-api-key)
- security requirement on /ws/stats operation
- 401 response documentation with example

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 9, 2026

Warning

Rate limit exceeded

@0x-SquidSol has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 5 minutes and 3 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 5 minutes and 3 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: b0af6604-bca6-41b0-846a-9e028e24ad29

📥 Commits

Reviewing files that changed from the base of the PR and between fb94c29 and ccc19de.

📒 Files selected for processing (1)
  • openapi.yaml
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant