Skip to content

Commit b4a45bd

Browse files
docs: update missed client packages methods comments
1 parent 1d706c0 commit b4a45bd

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

pulsaradmin/pkg/admin/packages.go

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,14 @@ import (
3737

3838
// Packages is admin interface for functions management
3939
type Packages interface {
40-
// Download Function/Connector Package
40+
// Download downloads Function/Connector Package
4141
// @param destinationFile
4242
// file where data should be downloaded to
4343
// @param packageURL
4444
// the package URL
4545
Download(packageURL, destinationFile string) error
4646

47-
// Download Function/Connector Package
47+
// DownloadWithContext downloads Function/Connector Package
4848
// @param ctx
4949
// context used for the request
5050
// @param destinationFile
@@ -53,7 +53,7 @@ type Packages interface {
5353
// the package URL
5454
DownloadWithContext(ctx context.Context, packageURL, destinationFile string) error
5555

56-
// Upload Function/Connector Package
56+
// Upload uploads Function/Connector Package
5757
// @param filePath
5858
// file where data should be uploaded to
5959
// @param packageURL
@@ -66,7 +66,7 @@ type Packages interface {
6666
// external infromations of a package
6767
Upload(packageURL, filePath, description, contact string, properties map[string]string) error
6868

69-
// Upload Function/Connector Package
69+
// UploadWithContext uploads Function/Connector Package
7070
// @param ctx
7171
// context used for the request
7272
// @param filePath
@@ -81,34 +81,34 @@ type Packages interface {
8181
// external infromations of a package
8282
UploadWithContext(ctx context.Context, packageURL, filePath, description, contact string, properties map[string]string) error
8383

84-
// List all the packages with the given type in a namespace
84+
// List lists all the packages with the given type in a namespace
8585
List(typeName, namespace string) ([]string, error)
8686

87-
// List all the packages with the given type in a namespace
87+
// ListWithContext lists all the packages with the given type in a namespace
8888
ListWithContext(ctx context.Context, typeName, namespace string) ([]string, error)
8989

90-
// ListVersions list all the versions of a package
90+
// ListVersions lists all the versions of a package
9191
ListVersions(packageURL string) ([]string, error)
9292

93-
// ListVersions list all the versions of a package
93+
// ListVersionsWithContext lists all the versions of a package
9494
ListVersionsWithContext(ctx context.Context, packageURL string) ([]string, error)
9595

9696
// Delete the specified package
9797
Delete(packageURL string) error
9898

99-
// Delete the specified package
99+
// DeleteWithContext the specified package
100100
DeleteWithContext(ctx context.Context, packageURL string) error
101101

102-
// GetMetadata get a package metadata information
102+
// GetMetadata returns a package metadata information
103103
GetMetadata(packageURL string) (utils.PackageMetadata, error)
104104

105-
// GetMetadata get a package metadata information
105+
// GetMetadataWithContext returns a package metadata information
106106
GetMetadataWithContext(ctx context.Context, packageURL string) (utils.PackageMetadata, error)
107107

108-
// UpdateMetadata update a package metadata information
108+
// UpdateMetadata updates a package metadata information
109109
UpdateMetadata(packageURL, description, contact string, properties map[string]string) error
110110

111-
// UpdateMetadata update a package metadata information
111+
// UpdateMetadataWithContext updates a package metadata information
112112
UpdateMetadataWithContext(ctx context.Context, packageURL, description, contact string, properties map[string]string) error
113113
}
114114

0 commit comments

Comments
 (0)