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(analysis): UrlAnalysis.from_latest_analysis queries submitted-url #154

Merged
merged 1 commit into from
Feb 26, 2025

Conversation

OrenIntezer
Copy link
Contributor

@OrenIntezer OrenIntezer commented Feb 26, 2025

Summary by CodeRabbit

  • Chores
    • Updated the SDK version to 1.21.12.
  • Documentation
    • Enhanced API documentation for URL analysis, clarifying usage details and offering improved query control for retrieving the latest analysis.

Copy link

coderabbitai bot commented Feb 26, 2025

Walkthrough

This pull request updates the SDK version from "1.21.11" to "1.21.12" and refines documentation in the UrlAnalysis class of the analysis module. Specifically, the from_latest_analysis method’s docstring has been enhanced and its function call updated to use submitted_url instead of url, ensuring clarity in parameter usage.

Changes

File(s) Change Summary
intezer_sdk/__init__.py Updated the __version__ variable from "1.21.11" to "1.21.12".
intezer_sdk/analysis.py Modified the docstring for the from_latest_analysis method in the UrlAnalysis class and changed the parameter in the call to query_url_analyses_history from url to submitted_url.

Possibly related PRs

Tip

CodeRabbit's docstrings feature is now available as part of our Pro Plan! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

✨ Finishing Touches
  • 📝 Generate Docstrings

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 generate docstrings to generate docstrings for this 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.

@OrenIntezer OrenIntezer force-pushed the feat/fix-fetching-url-analyses-TKT-6787 branch from 01ca3fc to dad1c56 Compare February 26, 2025 08:52
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: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6f9aac5 and dad1c56.

📒 Files selected for processing (2)
  • intezer_sdk/__init__.py (1 hunks)
  • intezer_sdk/analysis.py (2 hunks)
✅ Files skipped from review due to trivial changes (1)
  • intezer_sdk/init.py
🔇 Additional comments (1)
intezer_sdk/analysis.py (1)

394-396: Clear and helpful documentation improvement

The docstring now clearly communicates that the url parameter refers to the 'submitted URL' and provides guidance about using the more advanced query_url_analyses_history method when needed.

@intezer intezer deleted a comment from notion-workspace bot Feb 26, 2025
@daniel-oronsi daniel-oronsi changed the title fix(analysis): UrlAnalysis.from_latest_analysis queries submitted-url TKT-6787 fix(analysis): UrlAnalysis.from_latest_analysis queries submitted-url Feb 26, 2025
@OrenIntezer OrenIntezer merged commit a41b835 into master Feb 26, 2025
8 checks passed
@OrenIntezer OrenIntezer deleted the feat/fix-fetching-url-analyses-TKT-6787 branch February 26, 2025 09:50
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.

2 participants