feat: add missing godocs

juju · Aug 6, 2024 · fc07a6a · fc07a6a
1 parent 5e8e75e
commit fc07a6a
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/internal/juju/interfaces.go b/internal/juju/interfaces.go
@@ -78,6 +78,7 @@ type SecretAPIClient interface {
 	RevokeSecret(uri *secrets.URI, name string, apps []string) ([]error, error)
 }
 
+// JaasAPIClient defines the set of methods that the JAAS API provides.
 type JaasAPIClient interface {
 	ListRelationshipTuples(req *jaasparams.ListRelationshipTuplesRequest) (*jaasparams.ListRelationshipTuplesResponse, error)
 	AddRelation(req *jaasparams.AddRelationRequest) error

diff --git a/internal/juju/jaas.go b/internal/juju/jaas.go
@@ -1,4 +1,4 @@
-// Copyright 2023 Canonical Ltd.
+// Copyright 2024 Canonical Ltd.
 // Licensed under the Apache License, Version 2.0, see LICENCE file for details.
 
 package juju
@@ -25,6 +25,7 @@ func newJaasClient(sc SharedClient) *jaasClient {
 	}
 }
 
+// AddRelations attempts to create the provided slice of relationship tuples.
 func (jc *jaasClient) AddRelations(tuples []params.RelationshipTuple) error {
 	conn, err := jc.GetConnection(nil)
 	if err != nil {
@@ -38,6 +39,7 @@ func (jc *jaasClient) AddRelations(tuples []params.RelationshipTuple) error {
 	return cl.AddRelation(&req)
 }
 
+// DeleteRelations attempts to delete the provided slice of relationship tuples.
 func (jc *jaasClient) DeleteRelations(tuples []params.RelationshipTuple) error {
 	conn, err := jc.GetConnection(nil)
 	if err != nil {
@@ -51,6 +53,7 @@ func (jc *jaasClient) DeleteRelations(tuples []params.RelationshipTuple) error {
 	return cl.RemoveRelation(&req)
 }
 
+// ReadRelations attempts to read relations that match the criteria defined by `tuple`.
 func (jc *jaasClient) ReadRelations(tuple *params.RelationshipTuple) ([]params.RelationshipTuple, error) {
 	if tuple == nil {
 		return nil, errors.New("add relation request nil")

diff --git a/internal/juju/jaas_test.go b/internal/juju/jaas_test.go
@@ -1,4 +1,4 @@
-// Copyright 2023 Canonical Ltd.
+// Copyright 2024 Canonical Ltd.
 // Licensed under the Apache License, Version 2.0, see LICENCE file for details.
 
 package juju