Allow query parameters on endpoints. Fix various endpoints.

[chintal]

Description

Fixes #171
Fixes #173
Fixes #174

Adds a util to format list-type params. Should not break any existing user code, but gives the option to provide such parameter values as a list instead of needing to construct a string of comma separated values.

Checklist

• The patch has appropriate test coverage
• The patch follows the style guidelines of this project
• The patch has appropriate comments, particularly in hard-to-understand areas
• The documentation was updated corresponding to the patch
• I have performed a self-review of this patch

[amotl]

Dear @chintal,

thank you very much for your contribution. Your patch looks sane, I don't know why the PR fails on CI/GHA, we will need to look into that.

With kind regards,
Andreas.

[chintal]

The failures look like they are some old tests failing. main by itself fails a number of tests. The PR is simple enough that it can be trivially rebased and applied once main is fixed.

[chintal]

My apologies for the combined PR for unrelated issues. I'll try to remember to create the PR from a branch next time.

[chintal]

By the way, the issue with the tests failing seems to be on line 163 of test_grafana_client.py and the behavior (?) of https://example.org.

https://github.com/panodata/grafana-client/blob/7f5712c7953bde359abcdbbfb783af29d0b59b0f/test/test_grafana_client.py#L163

The actual response received from example.com seems to be 500, though the text in the body of the response reads like a 404. So while the test checks for GrafanaClientError, it actually raises GrafanaServerError.

https://github.com/panodata/grafana-client/blob/7f5712c7953bde359abcdbbfb783af29d0b59b0f/grafana_client/client.py#L157-L172

[codecov]

Codecov Report

Attention: Patch coverage is 76.66667% with 7 lines in your changes are missing coverage. Please review.

Project coverage is 92.26%. Comparing base (7303ec2) to head (d341a2b).
Report is 25 commits behind head on main.

Files	Patch %	Lines
grafana_client/elements/user.py	33.33%	4 Missing ⚠️
grafana_client/elements/search.py	85.71%	2 Missing ⚠️
grafana_client/util.py	75.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #172      +/-   ##
==========================================
- Coverage   94.44%   92.26%   -2.19%     
==========================================
  Files          26       27       +1     
  Lines        1711     1810      +99     
==========================================
+ Hits         1616     1670      +54     
- Misses         95      140      +45     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[amotl]

By the way, the issue with the tests failing seems to be on line 163 of test_grafana_client.py and the behavior (?) of https://example.org/.

Indeed, example.org, on its /api endpoint, seems to respond with both 500 and 404 status codes now, specifically with HTTP 500 on /api/health.

HTTP/1.1 404 Not Found

http HEAD https://example.org/api/foo
http HEAD https://example.org/api/hello

HTTP/1.1 500 Internal Server Error

http HEAD https://example.org/api/bar
http HEAD https://example.org/api/world
http HEAD https://example.org/api/health

It's weird, but c'est la vie, right?

[amotl]

Dear Chintalagiri,

thank you so much for fixing those embarrassing flaws of grafana-client, and for adding new functionality around the User/Teams API endpoint wrapper. Excellent!

Keep up that good work, and with kind regards,
Andreas.

[amotl]

It looks like this was missing, right? Thanks for spotting, and fixing per 4144e92!

Maybe we can come up with an idea and routine to prevent such details slipping through on future occasions, on behalf of script/generate_async.py, if it's not too much of a hassle?

/cc @Ousret

[Ousret]

It should be easy to implement, yes.
There's another option, a bit more straightforward (without generate_async.py): "getattr + module async inspect" on init to check if one api is missing in both sync and async. then raise a warning or error.

regards,

[amotl]

grafana-client 4.1.0 has been released, including your fixes and improvements. Thanks again.

NB: Fixing those flaws so diligently and swiftly clearly makes you eligible to be added as a collaborator on this project, so we've just invited you. Feel free to join if that fits your bill.