add godocs

canonical · Aug 27, 2024 · b797594 · b797594
1 parent bbe0a5c
commit b797594
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git a/internal/jimmtest/mocks/model.go b/internal/jimmtest/mocks/model.go
@@ -15,6 +15,7 @@ import (
 	"github.com/canonical/jimm/v3/pkg/api/params"
 )
 
+// ModelManager defines the mock struct used to implement the ModelManger interface.
 type ModelManager struct {
 	AddModel_               func(ctx context.Context, u *openfga.User, args *jimm.ModelCreateArgs) (*jujuparams.ModelInfo, error)
 	ChangeModelCredential_  func(ctx context.Context, user *openfga.User, modelTag names.ModelTag, cloudCredentialTag names.CloudCredentialTag) error

diff --git a/internal/jujuapi/modelmanager.go b/internal/jujuapi/modelmanager.go
@@ -55,6 +55,7 @@ func init() {
 	}
 }
 
+// ModelManager defines the model related operations that JIMM can perform.
 type ModelManager interface {
 	AddModel(ctx context.Context, u *openfga.User, args *jimm.ModelCreateArgs) (_ *jujuparams.ModelInfo, err error)
 	ChangeModelCredential(ctx context.Context, user *openfga.User, modelTag names.ModelTag, cloudCredentialTag names.CloudCredentialTag) error