Pulls version from package json

[abtestingalpha]

Description
Pulls package.json version into swagger docs.

Summary by CodeRabbit

• Chores
  • Updated the OpenAPI documentation versioning to dynamically pull from the package version, improving maintainability and consistency.

[coderabbitai]

Walkthrough

The changes involve updating the version number in the OpenAPI documentation configuration within the swagger.ts file. The hardcoded version string has been replaced with a dynamic import from the package.json file, ensuring that the version number reflects the current package version. This adjustment maintains the existing structure and functionality of the OpenAPI options.

Changes

Files	Change Summary
packages/rest-api/src/swagger.ts	Updated version variable to import from ../package.json instead of hardcoded string '1.0.77'.

Sequence Diagram(s)

sequenceDiagram
    participant Swagger as Swagger.ts
    participant Package as package.json
    Swagger->>Package: Import version
    Package-->>Swagger: Provide current version
    Swagger->>Swagger: Set version in OpenAPI options

Loading

Poem

In the code where rabbits play,
A version change has come our way.
No more numbers set in stone,
Now it dances, free to roam.
With each release, it hops along,
Keeping our docs both fresh and strong! 🐇✨

---

Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8127a4c and f97db83.

Files selected for processing (1)

• packages/rest-api/src/swagger.ts (2 hunks)

Additional comments not posted (3)

packages/rest-api/src/swagger.ts (3)

3-4: LGTM!

Importing the version from package.json is a good practice. It eliminates the need for manual updates and ensures consistency between the package version and the API documentation.

---

15-15: Dynamically setting the version is a good improvement.

Replacing the hardcoded version string with the imported version variable ensures that the API documentation always reflects the current package version. This eliminates the need for manual updates and reduces the risk of inconsistencies.

---

15-15: Verify the impact on API clients.

While dynamically setting the version is a good improvement, it's important to consider the potential impact on API clients that may be relying on a specific version.

Please ensure that this change is properly communicated to the API consumers, possibly through release notes or versioning guidelines, to avoid any unexpected behavior.

---

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
• Mastodon
• Reddit
• LinkedIn

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 37.95009%. Comparing base (49cf94d) to head (f97db83).
Report is 4 commits behind head on master.

Additional details and impacted files

@@              Coverage Diff              @@
##              master       #3160   +/-   ##
=============================================
  Coverage   37.95009%   37.95009%           
=============================================
  Files            418         418           
  Lines          24245       24245           
  Branches          82          82           
=============================================
  Hits            9201        9201           
  Misses         14306       14306           
  Partials         738         738           

Flag	Coverage Δ
packages	90.96267% <ø> (ø)

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]

Deploying sanguine-fe with    Cloudflare Pages

Latest commit:	f97db83
Status:	✅  Deploy successful!
Preview URL:	https://ea6d36f7.sanguine-fe.pages.dev
Branch Preview URL:	https://rest-api-version.sanguine-fe.pages.dev

View logs