From d5bec225ed78e0755a3dacb7658eec30a92dfa3d Mon Sep 17 00:00:00 2001 From: Will Browne Date: Fri, 19 Jan 2024 16:22:17 +0100 Subject: [PATCH] Plugins: Fix Plugin Context method docs (#80906) * fix method docs * add docs for new method --- .../plugincontext/plugincontext.go | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/pkg/services/pluginsintegration/plugincontext/plugincontext.go b/pkg/services/pluginsintegration/plugincontext/plugincontext.go index 54de3592e32..5c8440419ca 100644 --- a/pkg/services/pluginsintegration/plugincontext/plugincontext.go +++ b/pkg/services/pluginsintegration/plugincontext/plugincontext.go @@ -56,9 +56,9 @@ type Provider struct { logger log.Logger } -// Get allows getting plugin context by its ID. If datasourceUID is not empty string -// then PluginContext.DataSourceInstanceSettings will be resolved and appended to -// returned context. +// Get will retrieve plugin context by the provided pluginID and orgID. +// This is intended to be used for app plugin requests. +// PluginContext.AppInstanceSettings will be resolved and appended to the returned context. // Note: identity.Requester can be nil. func (p *Provider) Get(ctx context.Context, pluginID string, user identity.Requester, orgID int64) (backend.PluginContext, error) { plugin, exists := p.pluginStore.Plugin(ctx, pluginID) @@ -95,9 +95,10 @@ func (p *Provider) Get(ctx context.Context, pluginID string, user identity.Reque return pCtx, nil } -// GetWithDataSource allows getting plugin context by its ID and PluginContext.DataSourceInstanceSettings will be -// resolved and appended to the returned context. -// Note: *user.SignedInUser can be nil. +// GetWithDataSource will retrieve plugin context by the provided pluginID and datasource. +// This is intended to be used for datasource plugin requests. +// PluginContext.DataSourceInstanceSettings will be resolved and appended to the returned context. +// Note: identity.Requester can be nil. func (p *Provider) GetWithDataSource(ctx context.Context, pluginID string, user identity.Requester, ds *datasources.DataSource) (backend.PluginContext, error) { plugin, exists := p.pluginStore.Plugin(ctx, pluginID) if !exists { @@ -131,6 +132,8 @@ func (p *Provider) GetWithDataSource(ctx context.Context, pluginID string, user return pCtx, nil } +// PluginContextForDataSource will retrieve plugin context by the provided pluginID and datasource UID / K8s name. +// This is intended to be used for datasource API server plugin requests. func (p *Provider) PluginContextForDataSource(ctx context.Context, pluginID, name string) (backend.PluginContext, error) { plugin, exists := p.pluginStore.Plugin(ctx, pluginID) if !exists {