grafana/pkg/services/store/kind/snapshot/summary.go

package snapshot

import (
	"context"
	"encoding/json"
	"fmt"

	"github.com/grafana/grafana/pkg/services/store/entity"
)

// A snapshot is a dashboard with no external queries and a few additional properties
type Model struct {
	Name         string          `json:"name"`
	Description  string          `json:"description,omitempty"`
	DeleteKey    string          `json:"deleteKey"`
	ExternalURL  string          `json:"externalURL"`
	Expires      int64           `json:"expires,omitempty"` // time that this expires
	DashboardUID string          `json:"dashboard,omitempty"`
	Snapshot     json.RawMessage `json:"snapshot,omitempty"`
}

func GetEntityKindInfo() entity.EntityKindInfo {
	return entity.EntityKindInfo{
		ID:   entity.StandardKindSnapshot,
		Name: "Snapshot",
	}
}

func GetEntitySummaryBuilder() entity.EntitySummaryBuilder {
	return func(ctx context.Context, uid string, body []byte) (*entity.EntitySummary, []byte, error) {
		obj := &Model{}
		err := json.Unmarshal(body, obj)
		if err != nil {
			return nil, nil, err // unable to read object
		}

		if obj.Name == "" {
			return nil, nil, fmt.Errorf("expected snapshot name")
		}
		if obj.DeleteKey == "" {
			return nil, nil, fmt.Errorf("expected delete key")
		}

		summary := &entity.EntitySummary{
			Kind:        entity.StandardKindFolder,
			Name:        obj.Name,
			Description: obj.Description,
			UID:         uid,
			Fields: map[string]interface{}{
				"deleteKey":   obj.DeleteKey,
				"externalURL": obj.ExternalURL,
				"expires":     obj.Expires,
			},
			References: []*entity.EntityExternalReference{
				{Family: entity.StandardKindDashboard, Identifier: obj.DashboardUID},
			},
		}

		// Keep the original body
		return summary, body, err
	}
}