[DNM] swagger bump [SLT-453]

trajan0x commented 2 weeks ago

Description A clear and concise description of the features you're adding in this pull request.

Additional context Add any other context about the problem you're solving.

Metadata

Fixes #[Link to Issue]

Summary by CodeRabbit

New Features
- Introduced functionality to generate Swagger documentation for the REST API.
- Enhanced /bridge endpoint response to include encoded transaction data (txData).
Updates
- Updated API title, version, and description in the Swagger documentation.
- Added new parameters to the /bridge endpoint for improved functionality.
Bug Fixes
- Standardized error response structures across endpoints for consistency.

coderabbitai[bot] commented 2 weeks ago

[!CAUTION]

Review failed

The pull request is closed.

Walkthrough

This pull request introduces significant enhancements to the Synapse REST API documentation and functionality. A new JavaScript file, generate-swagger.js, is added to generate OpenAPI documentation using the swagger-jsdoc library. The package.json is updated to include a new script for generating Swagger documentation and a new dependency. Additionally, modifications are made to the bridgeController and bridgeRoute files to incorporate transaction data encoding and update the response schema, respectively. A new configuration file for Swagger is also created, and the existing swagger.json is extensively revised.

Changes

File Path	Change Summary
`packages/rest-api/generate-swagger.js`	New file created to generate Swagger documentation using `swagger-jsdoc`.
`packages/rest-api/package.json`	New script `generate-swagger` added; dependency `@ethersproject/abi` introduced; minor formatting change.
`packages/rest-api/src/controllers/bridgeController.ts`	New constant `BRIDGE_INTERFACE` added; transaction data encoding implemented in the `bridgeController` function.
`packages/rest-api/src/routes/bridgeRoute.ts`	Response schema updated to include new property `txData: string` for the `/bridge` endpoint.
`packages/rest-api/swagger.config.js`	New configuration file created for Swagger API documentation.
`packages/rest-api/swagger.json`	Extensive updates to API metadata, parameters, response schemas, and overall structure.

Possibly related PRs

#3354: Enhances the Swagger documentation for the Synapse REST API, directly related to generate-swagger.js.
#3359: Adds a new endpoint to serve Swagger specifications, complementing the generate-swagger.js functionality.
#3362: Renames swagger.json to openapi.json, aligning with the focus on generating OpenAPI documentation.

Suggested labels

size/m, M-docs

Suggested reviewers

Defi-Moses
abtestingalpha
trajan0x

Poem

In the land of code where rabbits play,
New docs emerge to light the way.
With swagger's might, our paths align,
Encoding bridges, oh how they shine!
Hop along, let’s celebrate,
For clearer APIs, we can’t wait! 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

🪧 Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , please review it.` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (Invoked using PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

cloudflare-workers-and-pages[bot] commented 2 weeks ago

Deploying sanguine-fe with Cloudflare Pages

Latest commit:	`a1ebff3`
Status:	✅ Deploy successful!
Preview URL:	https://f1dfc000.sanguine-fe.pages.dev
Branch Preview URL:	https://fix-api-fix.sanguine-fe.pages.dev

View logs

synapsecns / sanguine