Skip to content

Commit 0302cf7

Browse files
committed
add comment for investigation name requirement
1 parent cd860a9 commit 0302cf7

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

pkg/investigations/investigation/investigation.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ type InvestigationResult struct {
2222

2323
type Investigation interface {
2424
Run(resources *Resources) (InvestigationResult, error)
25+
// Please note that when adding an investigation the name and the directory currently need to be the same,
26+
// so that backplane-api can fetch the metadata.yaml
2527
Name() string
2628
Description() string
2729
IsExperimental() bool

0 commit comments

Comments
 (0)