feat: endpoint /api/v1/genes/info with OpenAPI (#574)

[holtgrewe]

Summary by CodeRabbit

• New Features

  • Enhanced OpenAPI documentation with additional gene-related paths and components.
  • Introduced a new endpoint /api/v1/versionsInfo to provide version information for genes and annotation databases.

• Bug Fixes

  • Improved error handling in the new endpoint to manage data processing issues effectively.

• Documentation

  • Updated documentation comments to reflect specific implementations and functionalities.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces modifications to the .gitignore file and enhances the OpenAPI documentation and server functionality in the src/server/run/mod.rs and src/server/run/versions.rs files. The .gitignore file now includes an entry for the /.idea directory while retaining existing entries. The server files expand the API to handle gene information more comprehensively, adding new endpoints and structures for version information related to genes, along with improved documentation.

Changes

File Path	Change Summary
.gitignore	Added entry for /.idea, retained .vscode and /target, and preserved comments for #/Cargo.lock.
src/server/run/mod.rs	Enhanced OpenAPI documentation with new gene-related paths and integrated genes_info::handle_with_openapi. Added new gene-related components to the OpenAPI schema. Updated HttpServer setup.
src/server/run/versions.rs	Modified documentation comment and added new Actix web handler for /api/v1/versionsInfo. Introduced several new structs for version information response.

Possibly related issues

• Add endpoint /api/v1/genes/info with OpenAPI schema #574: The changes address the need for an OpenAPI schema for the /genes/info endpoint, aligning with the request for better documentation and versioning.
• Add endpoint /api/v1/genes/clinvar-info with OpenAPI schema #576: The introduction of new endpoints and OpenAPI enhancements relates to the request for an OpenAPI schema for the /genes/clinvar endpoint.

Possibly related PRs

• refactor: make versions infos endoint consistent with mehari #579: This PR involves modifications to the versioning functionality in src/server/run/versions.rs, which is directly related to the changes in the main PR regarding OpenAPI documentation and version handling.

Poem

🐰 In the garden where genes bloom bright,
New paths emerge in the soft moonlight.
With OpenAPI's grace, we now can see,
The stories of genes, wild and free!
So hop along, let’s share the news,
Of versions and info, in vibrant hues! 🌼

---

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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.