Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: seqvarsAnnosQuery missing in OpenAPI spec #600

Merged
merged 2 commits into from
Nov 20, 2024
Merged

Conversation

holtgrewe
Copy link
Contributor

@holtgrewe holtgrewe commented Nov 20, 2024

Summary by CodeRabbit

  • New Features

    • Introduced a new API endpoint /api/v1/seqvars/annos for querying annotations for a single variant.
  • Bug Fixes

    • Corrected a typo in the operation ID for the API endpoint, enhancing clarity and accuracy.
  • Improvements

    • Enhanced error handling for data fetching from annotation databases, providing clearer feedback during failures.
    • Updated the OpenAPI schema to streamline gene-related queries and responses.
  • Style

    • Minor adjustments made to comments and formatting for improved clarity.

Copy link

coderabbitai bot commented Nov 20, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request focus on the Rust implementation of the /api/v1/seqvars/annos endpoint and the OpenAPI schema. Key modifications include correcting the operation ID from seqvarsAnosQuery to seqvarsAnnosQuery and updating the endpoint's route from "/api/v1/genes/info" to "/api/v1/seqvars/annos". The handle_with_openapi function has been enhanced for better error handling, and a new response type SeqvarsAnnosResponse has been introduced. The OpenAPI schema has also been updated to reflect these changes and streamline the query structure.

Changes

File Path Change Summary
src/server/run/annos_variant.rs - Corrected operation ID from seqvarsAnosQuery to seqvarsAnnosQuery in OpenAPI attributes.
- Updated endpoint route from "/api/v1/genes/info" to "/api/v1/seqvars/annos".
- Enhanced handle_with_openapi for improved error handling with explicit error mapping.
- Introduced SeqvarsAnnosResponse type for response structure.
openapi.schema.yaml - Updated version from 0.41.3 to 0.42.0.
- Restructured /api/v1/genes/info endpoint and changed operation ID to genesInfo.
- Added optional hgnc_id parameter as an array for gene queries.
- Introduced new endpoint /api/v1/seqvars/annos with parameters for variant queries.

Possibly related PRs

🐇 In the code, a change was made,
A typo fixed, no longer a trade.
Errors now caught with care,
Robustness added, we declare!
Annotations fetched with a cheer,
Clarity shines, the path is clear! 🌟


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.

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
src/server/run/annos_variant.rs (1)

Line range hint 2828-3024: Consider refactoring the handler implementation for better maintainability and performance.

The implementation is functionally correct but could be improved:

  1. Extract genome release parsing into a separate function for better reusability
  2. Reduce query cloning by storing the parsed query once
  3. Make error messages more descriptive for better debugging

Consider applying these changes:

+ fn parse_genome_release(release: &str) -> Result<GenomeRelease, CustomError> {
+     release.parse().map_err(|e: strum::ParseError| {
+         CustomError::new(anyhow::anyhow!(
+             "invalid genome release '{}': {}",
+             release,
+             e
+         ))
+     })
+ }

 pub async fn handle_with_openapi(
     data: Data<crate::server::run::WebServerData>,
     _path: Path<()>,
     query: web::Query<SeqvarsAnnosQuery>,
 ) -> actix_web::Result<Json<SeqvarsAnnosResponse>, CustomError> {
-    let genome_release = query
-        .genome_release
-        .parse()
-        .map_err(|e: strum::ParseError| {
-            CustomError::new(anyhow::anyhow!("problem getting genome release: {}", e))
-        })?;
+    let genome_release = parse_genome_release(&query.genome_release)?;
+    let query_inner = query.into_inner();
+    let query_key: keys::Var = query_inner.clone().into();
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3a76285 and 32515d0.

📒 Files selected for processing (1)
  • src/server/run/annos_variant.rs (1 hunks)
🔇 Additional comments (2)
src/server/run/annos_variant.rs (2)

2827-2827: Operation ID typo fix looks good!

The operation ID has been correctly updated from "seqvarsAnosQuery" to "seqvarsAnnosQuery", fixing the typo as intended.


Line range hint 1-2826: Type definitions and implementations are well-structured!

The code demonstrates:

  • Comprehensive type definitions for various annotation sources
  • Consistent use of derive macros for serialization/deserialization
  • Clear documentation for each type
  • Proper error handling in type conversions

@holtgrewe holtgrewe changed the title fix: typo in seqvarsAnosQuery operation ID fix: seqvarsAnnosQuery missing in OpenAPI spec Nov 20, 2024
@holtgrewe holtgrewe merged commit 73bdb1d into main Nov 20, 2024
8 of 9 checks passed
@holtgrewe holtgrewe deleted the holtgrewe-patch-1 branch November 20, 2024 08:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant