feat: add comprehensive OpenAPI documentation and refactor routes#4
Merged
feat: add comprehensive OpenAPI documentation and refactor routes#4
Conversation
- Add Swagger/OpenAPI documentation for all API endpoints (files, code, notes, folders, users)
- Refactor route files into modular folder structure (crud/actions/trash/counts)
- Fix TypeScript type inference issues with OpenAPIHono validators
- Fix route registration order to prevent /{id} catching /empty-trash
- Increase file download rate limit to 1000 req/15min in development
- Add Swagger docs link to README (https://api.typelets.com/docs)
Owner
Author
|
🎉 This PR is included in version 1.8.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds comprehensive OpenAPI/Swagger documentation for all API endpoints and refactors route files into a
modular folder structure. It also fixes several TypeScript type inference issues and resolves critical bugs with
route registration and rate limiting.
Changes
📚 OpenAPI/Swagger Documentation
/docs/api/openapi.jsonsrc/lib/openapi-schemas.ts🗂️ Route Refactoring
src/routes/folders/→crud.ts+actions.tssrc/routes/notes/→crud.ts+actions.ts+trash.ts+counts.tssrc/routes/files/→crud.tssrc/routes/users/→crud.tssrc/routes/code/→crud.ts🔧 TypeScript Fixes
@hono/zod-openapivalidatorsContexttype annotations that broke type inferenceRouteHandler<typeof route>types for separately defined handlersinstanceof Error)🐛 Bug Fixes
/{id}routesrc/server.ts:361- trash router now registered before crud routerHTTP_FILE_RATE_LIMIT_MAXenvironment variable📝 Documentation
Test Plan
Breaking Changes
None - this is purely additive and fixes existing bugs.