serve swagger [SLT-449] #3359

trajan0x · 2024-11-01T21:54:56Z

Description

Serve swagger

Summary by CodeRabbit

New Features
- Introduced a new GET endpoint at /swagger.json to retrieve API specifications in JSON format.
Bug Fixes
- Maintained existing middleware functionality for logging and error handling without changes.

coderabbitai · 2024-11-01T21:55:17Z

Walkthrough

The changes introduce a new GET endpoint at /swagger.json in the Express application, which serves the Swagger specifications in JSON format. The existing middleware for logging requests and responses, as well as error handling mechanisms, remain unchanged. This new route integrates into the existing application structure without affecting the overall control flow.

Changes

File	Change Summary
packages/rest-api/src/app.ts	Added a GET route `/swagger.json` that returns `specs` in JSON format.

Possibly related PRs

omnirpc doc fixes #2637: The changes in this PR involve adding routes for serving Swagger documentation, which is directly related to the new /swagger.json endpoint introduced in the main PR.

Suggested labels

go, needs-go-generate-services/explorer, size/l, needs-go-generate-committee, needs-go-generate-sin-executor

Suggested reviewers

dwasse
aureliusbtc
ChiTimesChi

Poem

In the code where rabbits hop,
A new route blooms, we cannot stop!
/swagger.json now takes its place,
With specs in JSON, a joyful embrace.
Hopping along, the logs still flow,
In our API garden, watch it grow! 🐇✨

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 35a8789 and 96aa00d.

📒 Files selected for processing (1)

packages/rest-api/src/app.ts (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

packages/rest-api/src/app.ts

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, 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 for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

packages/rest-api/src/app.ts (1)
59-61: LGTM! Consider adding cache headers.

The implementation is clean and follows Express patterns. However, consider adding cache headers similar to the /api-docs endpoint to prevent unnecessary server load.
 app.get('/swagger.json', (_req, res) => {
+  res.set('Cache-Control', 'no-store, no-cache, must-revalidate, proxy-revalidate');
+  res.set('Pragma', 'no-cache');
+  res.set('Expires', '0');
+  res.set('Surrogate-Control', 'no-store');
   res.json(specs);
 });

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 47194e6 and 35a8789.

📒 Files selected for processing (1)

packages/rest-api/src/app.ts (1 hunks)

🔇 Additional comments (1)

packages/rest-api/src/app.ts (1)

59-61: Consider adding access controls to the Swagger documentation.

The Swagger specifications might contain sensitive API information. Consider implementing authentication/authorization middleware to restrict access to trusted consumers.

Let's verify if there are any existing auth middlewares in use:

codecov · 2024-11-01T22:00:11Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.44834%. Comparing base (47194e6) to head (96aa00d).
Report is 1 commits behind head on master.

Additional details and impacted files

@@              Coverage Diff              @@
##              master       #3359   +/-   ##
=============================================
  Coverage   90.44834%   90.44834%           
=============================================
  Files             54          54           
  Lines           1026        1026           
  Branches          82          82           
=============================================
  Hits             928         928           
  Misses            95          95           
  Partials           3           3

Flag	Coverage Δ
packages	`90.44834% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

cloudflare-workers-and-pages · 2024-11-01T22:00:30Z

Deploying sanguine-fe with Cloudflare Pages

Latest commit:	`96aa00d`
Status:	✅ Deploy successful!
Preview URL:	https://4c4e1eb9.sanguine-fe.pages.dev
Branch Preview URL:	https://fix-serve-swagger.sanguine-fe.pages.dev

View logs

serve swagger [SLT-449]

35a8789

trajan0x requested a review from Defi-Moses as a code owner November 1, 2024 21:54

github-actions bot added Sol Typescript size/xs labels Nov 1, 2024

coderabbitai bot reviewed Nov 1, 2024

View reviewed changes

fix lint issue

96aa00d

trajan0x merged commit 6df489d into master Nov 1, 2024
36 checks passed

trajan0x deleted the fix/serve-swagger branch November 1, 2024 22:10

This was referenced Nov 1, 2024

chore(rest-api): rename swagger.json to openapi.json [SLT-449] #3362

Merged

[DNM] swagger bump [SLT-453] #3367

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

serve swagger [SLT-449] #3359

serve swagger [SLT-449] #3359

trajan0x commented Nov 1, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 1, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

codecov bot commented Nov 1, 2024 •

edited

Loading

cloudflare-workers-and-pages bot commented Nov 1, 2024 •

edited

Loading

serve swagger [SLT-449] #3359

serve swagger [SLT-449] #3359

Conversation

trajan0x commented Nov 1, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Nov 1, 2024 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

codecov bot commented Nov 1, 2024 • edited Loading

Codecov Report

cloudflare-workers-and-pages bot commented Nov 1, 2024 • edited Loading

Deploying sanguine-fe with Cloudflare Pages

trajan0x commented Nov 1, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Nov 1, 2024 •

edited

Loading

codecov bot commented Nov 1, 2024 •

edited

Loading

cloudflare-workers-and-pages bot commented Nov 1, 2024 •

edited

Loading