Skip to content
This repository has been archived by the owner on Jan 20, 2025. It is now read-only.

Add codeVariants to search issues rest api #103

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

vaskoandras
Copy link

@vaskoandras vaskoandras commented Nov 28, 2024

Add codeVariants paramter to the api/issues/search api call

Summary by Sourcery

新功能:

  • 在 SonarQube REST API 中的 'search_issues' 函数中引入新的 'codeVariants' 参数,允许用户通过特定的代码变体过滤问题。
Original summary in English

Summary by Sourcery

New Features:

  • Introduce a new 'codeVariants' parameter to the 'search_issues' function in the SonarQube REST API, allowing users to filter issues by specific code variants.

Copy link

sourcery-ai bot commented Nov 28, 2024

审核指南 by Sourcery

此PR为SonarQube REST客户端的search_issues API函数添加了一个新的可选参数'codeVariants'。实现过程简单,保持了现有参数结构和文档风格的同时,将参数添加到函数签名中。

更新后的search_issues函数的类图

classDiagram
    class search_issues {
        +assigned
        +assignees
        +author
        +codeVariants
        +createdAfter
        +createdAt
        +createdBefore
    }
    note for search_issues "在函数签名中添加了codeVariants参数"
Loading

文件级别的更改

更改 详情 文件
在搜索问题API中为代码变体过滤添加了新的可选参数
  • 在函数签名中添加了'codeVariants'参数
  • 添加了参数文档,描述为逗号分隔的代码变体列表
sonarqube/rest/issues.py

提示和命令

与Sourcery互动

  • 触发新审核: 在拉取请求上评论@sourcery-ai review
  • 继续讨论: 直接回复Sourcery的审核评论。
  • 从审核评论生成GitHub问题: 通过回复审核评论,要求Sourcery从中创建一个问题。
  • 生成拉取请求标题: 在拉取请求标题的任何地方写@sourcery-ai以随时生成标题。
  • 生成拉取请求摘要: 在拉取请求正文的任何地方写@sourcery-ai summary以随时生成PR摘要。您也可以使用此命令指定摘要应插入的位置。

自定义您的体验

访问您的仪表板以:

  • 启用或禁用审核功能,如Sourcery生成的拉取请求摘要、审核指南等。
  • 更改审核语言。
  • 添加、删除或编辑自定义审核说明。
  • 调整其他审核设置。

获取帮助

Original review guide in English

Reviewer's Guide by Sourcery

This PR adds a new optional parameter 'codeVariants' to the search_issues API function in the SonarQube REST client. The implementation is straightforward, adding the parameter to the function signature while maintaining the existing parameter structure and documentation style.

Class diagram for updated search_issues function

classDiagram
    class search_issues {
        +assigned
        +assignees
        +author
        +codeVariants
        +createdAfter
        +createdAt
        +createdBefore
    }
    note for search_issues "Added codeVariants parameter to the function signature"
Loading

File-Level Changes

Change Details Files
Added new optional parameter for code variants filtering in the search issues API
  • Added 'codeVariants' parameter to function signature
  • Added parameter documentation describing it as a comma-separated list of code variants
sonarqube/rest/issues.py

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

Quality Gate Failed Quality Gate failed

Failed conditions
B Maintainability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

@vaskoandras - 我已经审查了你的更改 - 这里有一些反馈:

总体评论

  • 请增强 codeVariants 参数的文档,以解释在 SonarQube 的上下文中代码变体是什么,并可能包括一个使用示例。
这是我在审查期间查看的内容
  • 🟢 一般问题:一切看起来都很好
  • 🟢 安全性:一切看起来都很好
  • 🟢 测试:一切看起来都很好
  • 🟢 复杂性:一切看起来都很好
  • 🟢 文档:一切看起来都很好

Sourcery 对开源项目免费 - 如果你喜欢我们的评论,请考虑分享它们 ✨
帮助我变得更有用!请在每条评论上点击 👍 或 👎,我将使用反馈来改进你的评论。
Original comment in English

Hey @vaskoandras - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Please enhance the documentation for the codeVariants parameter to explain what code variants are in the context of SonarQube and possibly include a usage example.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant