Alerting Provisioning: Added support for the `name` query parameter #230

amotl · 2025-07-27T00:44:07Z

About

The get_contactpoints method receives support for filtering by name, as suggested by @devth. Thanks!

... to the `get_contactpoints` method, for filtering by name.

coderabbitai · 2025-07-27T00:44:15Z

Summary by CodeRabbit

New Features
- Added support for filtering contact points by name in the Alerting Provisioning API. Users can now specify a name to retrieve only matching contact points.
Documentation
- Updated changelog to reflect the new filtering capability in the Alerting Provisioning API.

Walkthrough

The get_contactpoints method in both the async and sync AlertingProvisioning classes was updated to accept an optional name parameter, allowing filtering of contact points by name via a query parameter. The changelog was also updated to document this new feature.

Changes

File(s)	Change Summary
grafana_client/elements/_async/alertingprovisioning.py, grafana_client/elements/alertingprovisioning.py	Updated `get_contactpoints` method to accept optional `name` parameter for filtering by contact point name.
CHANGELOG.md	Added entry documenting the new `name` filter feature for `get_contactpoints` in Alerting Provisioning API.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant AlertingProvisioning
    participant GrafanaAPI

    User->>AlertingProvisioning: get_contactpoints(name)
    AlertingProvisioning->>GrafanaAPI: GET /contact-points?name={name}
    GrafanaAPI-->>AlertingProvisioning: Response (filtered contact points)
    AlertingProvisioning-->>User: Return filtered contact points

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Poem

A rabbit hops through code so bright,
Filtering contact points just right.
With a name in tow, it leaps ahead,
Fetching results as the changelog said.
Ears up high, it celebrates the day—
New features found, the Grafana way! 🐇✨

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3fc0400 and 1400660.

📒 Files selected for processing (3)

CHANGELOG.md (1 hunks)
grafana_client/elements/_async/alertingprovisioning.py (1 hunks)
grafana_client/elements/alertingprovisioning.py (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (2)

grafana_client/elements/_async/alertingprovisioning.py (1)

grafana_client/elements/alertingprovisioning.py (1)

get_contactpoints (84-93)

grafana_client/elements/alertingprovisioning.py (1)

grafana_client/elements/_async/alertingprovisioning.py (1)

get_contactpoints (84-93)

🔇 Additional comments (3)

CHANGELOG.md (1)

5-6: LGTM! Clear and accurate changelog entry.

The changelog entry properly documents the new feature and follows the established format. The description accurately reflects the addition of the optional name parameter for filtering contact points.

grafana_client/elements/alertingprovisioning.py (1)

84-93: LGTM! Clean implementation of name filtering.

The implementation correctly:

Adds an optional name parameter with appropriate default value

Uses conditional logic to only include the name query parameter when provided

Updates the docstring to reflect the new filtering capability

Maintains backward compatibility

grafana_client/elements/_async/alertingprovisioning.py (1)

84-93: LGTM! Consistent async implementation.

The async implementation correctly mirrors the synchronous version with proper async/await usage. The parameter handling logic and documentation are identical, maintaining excellent consistency between the sync and async APIs.

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch contactpoints-filter-name

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests 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.

codecov · 2025-07-27T00:44:54Z

Codecov Report

❌ Patch coverage is 16.66667% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 92.25%. Comparing base (7acc4d8) to head (1400660).
⚠️ Report is 6 commits behind head on main.

Files with missing lines	Patch %	Lines
grafana_client/elements/alertingprovisioning.py	16.66%	5 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #230      +/-   ##
==========================================
- Coverage   92.40%   92.25%   -0.16%     
==========================================
  Files          27       27              
  Lines        1818     1821       +3     
==========================================
  Hits         1680     1680              
- Misses        138      141       +3

Flag	Coverage Δ
unittests	`92.25% <16.66%> (-0.16%)`	⬇️

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.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Alerting Provisioning: Added support for the name query parameter

1400660

... to the `get_contactpoints` method, for filtering by name.

amotl temporarily deployed to pypi July 27, 2025 00:44 — with GitHub Actions Inactive

amotl mentioned this pull request Jul 27, 2025

Support get_contactpoints query param #220

Closed

amotl marked this pull request as ready for review July 27, 2025 00:48

amotl merged commit e0b78f1 into main Jul 27, 2025
9 checks passed

amotl deleted the contactpoints-filter-name branch July 27, 2025 00:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Alerting Provisioning: Added support for the `name` query parameter #230

Alerting Provisioning: Added support for the `name` query parameter #230

Uh oh!

amotl commented Jul 27, 2025

Uh oh!

coderabbitai bot commented Jul 27, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov bot commented Jul 27, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Alerting Provisioning: Added support for the name query parameter #230

Alerting Provisioning: Added support for the name query parameter #230

Uh oh!

Conversation

amotl commented Jul 27, 2025

About

Uh oh!

coderabbitai bot commented Jul 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented Jul 27, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Alerting Provisioning: Added support for the `name` query parameter #230

Alerting Provisioning: Added support for the `name` query parameter #230

coderabbitai bot commented Jul 27, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Jul 27, 2025 •

edited

Loading