feat(backend): OpenAPI specification for HTTP API#57
Open
RemmyAcee wants to merge 5 commits intoStreampay-Org:mainfrom
Open
feat(backend): OpenAPI specification for HTTP API#57RemmyAcee wants to merge 5 commits intoStreampay-Org:mainfrom
RemmyAcee wants to merge 5 commits intoStreampay-Org:mainfrom
Conversation
|
@RemmyAcee 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! 🚀 |
Contributor
Author
|
Done, Close: #57 |
Contributor
|
PLease resolve the conflicts |
Contributor
Author
Done |
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
2 participants
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.
Close: #22
I have successfully implemented the OpenAPI 3 specification for the StreamPay-Backend.
Key accomplishments:
Defined Zod schemas with OpenAPI extensions for API objects.
Implemented the /api/openapi.json route to serve the generated specification.
Added snapshot tests for the OpenAPI document.
Updated the README with the new endpoint information.
Fixed several pre-existing linting errors to ensure a clean codebase.
All tests (19 passed) and linting (0 errors) are passing. You can review the changes in the attached walkthrough.