feat: full OpenAPI 3.1 spec for the billing, usage, and developer routes#370
Open
emarc99 wants to merge 1 commit into
Open
feat: full OpenAPI 3.1 spec for the billing, usage, and developer routes#370emarc99 wants to merge 1 commit into
emarc99 wants to merge 1 commit into
Conversation
|
@emarc99 Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
Author
|
@greatest0fallt1me build errors are unrelated to my changes. |
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.
Description
This PR implements and serves a machine-readable OpenAPI 3.1 specification covering the billing, usage, and developer routes, and introduces an automated coverage and schema validation test suite.
Key Changes
docs/openapi.json): Authored a complete, valid OpenAPI 3.1 specification detailing the/api/billing/deduct,/api/usage,/api/apis, and/api/developers/revenueendpoints, including exact request/response schemas and standardized error shapes (ErrorResponse).src/routes/index.ts): MountedGET /api/openapi.jsonto dynamically serve the contract. Replaced thefileURLToPathES-module logic withprocess.cwd()to prevent CommonJS/Jest transpilation issues.src/app.test.ts): Added tests verifying:better-sqlite3./api/usage(requires auth) and/api/openapi.json(public).Verification Results
npm test -- src/app.test.tsto execute all 58 suite tests.