GrafanaJsonDatasource icon indicating copy to clipboard operation
GrafanaJsonDatasource copied to clipboard

Mark /metric-payload-options optional in docs

Open zeisss opened this issue 1 year ago • 3 comments

When the payload type is select or multi-select and the payload options configuration is empty, expanding the drop-down menu will trigger this API. The request body will carry the current metric and payload.

I recently implemented the endpoints, but missed the /metric-payload-options endpoint (thus serving a 404). The docs state this endpoint is requested to fill the payload options, if they are empty, but I am still seeing requests to this endpoint even though I always serve the options when describing the available metrics.

It feels like the docs are a bit inconsistent from what I am seeing: a) It doesn't seem to actually be required since it works just fine as I am serving a 404 and provide the options in the initial metrics structure b) The docs state this is only requests if the options are empty, but I am still seeing requests

zeisss avatar Aug 16 '24 12:08 zeisss

👋🏾 can you send PR with a fix? I believe it is in QueryBuilderPayloadSelect

simPod avatar Sep 10 '24 09:09 simPod

So we want to follow a) the docs and skip the request or b) just update the docs to mention the request will be made anyways, but a 404 is fine?

zeisss avatar Sep 23 '24 08:09 zeisss

I think the datasource should not make the request as stated in the docs now (?)

simPod avatar Sep 27 '24 09:09 simPod

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

github-actions[bot] avatar Oct 28 '24 02:10 github-actions[bot]

This issue has not seen any activity since it was marked stale. Closing.

github-actions[bot] avatar Nov 05 '24 02:11 github-actions[bot]