Skip to content

Commit 4eb2292

Browse files
authored
feat(ipfs): add cli command for ipfs naming (#1829)
1 parent 45ad1e0 commit 4eb2292

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

api/ipfs/v1alpha1/ipfs_sdk.go

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -302,10 +302,10 @@ type Name struct {
302302
Name string `json:"name"`
303303

304304
Key string `json:"key"`
305-
306-
Cid string `json:"cid"`
307305
// Status: default value: unknown_status
308306
Status NameStatus `json:"status"`
307+
308+
Value string `json:"value"`
309309
}
310310

311311
type Pin struct {
@@ -844,7 +844,7 @@ type ListPinsRequest struct {
844844
}
845845

846846
// ListPins: list all pins within a volume.
847-
// Retrieve information about all pins into a volume.
847+
// Retrieve information about all pins within a volume.
848848
func (s *API) ListPins(req *ListPinsRequest, opts ...scw.RequestOption) (*ListPinsResponse, error) {
849849
var err error
850850

@@ -940,9 +940,11 @@ type CreateNameRequest struct {
940940

941941
Name string `json:"name"`
942942

943-
Cid string `json:"cid"`
943+
Value string `json:"value"`
944944
}
945945

946+
// CreateName: create a new name.
947+
// You can use the `ipfs key` command to list and generate more names and their respective keys.
946948
func (s *API) CreateName(req *CreateNameRequest, opts ...scw.RequestOption) (*Name, error) {
947949
var err error
948950

@@ -987,6 +989,8 @@ type GetNameRequest struct {
987989
NameID string `json:"-"`
988990
}
989991

992+
// GetName: get information about a name.
993+
// Retrieve information about a specific name.
990994
func (s *API) GetName(req *GetNameRequest, opts ...scw.RequestOption) (*Name, error) {
991995
var err error
992996

@@ -1025,6 +1029,8 @@ type DeleteNameRequest struct {
10251029
NameID string `json:"-"`
10261030
}
10271031

1032+
// DeleteName: delete an existing name.
1033+
// Delete a name by its ID.
10281034
func (s *API) DeleteName(req *DeleteNameRequest, opts ...scw.RequestOption) error {
10291035
var err error
10301036

@@ -1069,6 +1075,8 @@ type ListNamesRequest struct {
10691075
OrganizationID *string `json:"-"`
10701076
}
10711077

1078+
// ListNames: list all names by a Project ID.
1079+
// Retrieve information about all names from a Project ID.
10721080
func (s *API) ListNames(req *ListNamesRequest, opts ...scw.RequestOption) (*ListNamesResponse, error) {
10731081
var err error
10741082

@@ -1119,9 +1127,11 @@ type UpdateNameRequest struct {
11191127

11201128
Tags *[]string `json:"tags"`
11211129

1122-
Cid *string `json:"cid"`
1130+
Value *string `json:"value"`
11231131
}
11241132

1133+
// UpdateName: update name information.
1134+
// Update name information (CID, tag, name...).
11251135
func (s *API) UpdateName(req *UpdateNameRequest, opts ...scw.RequestOption) (*Name, error) {
11261136
var err error
11271137

@@ -1165,6 +1175,8 @@ type ExportKeyNameRequest struct {
11651175
NameID string `json:"-"`
11661176
}
11671177

1178+
// ExportKeyName: export your private key.
1179+
// Export a private key by its ID.
11681180
func (s *API) ExportKeyName(req *ExportKeyNameRequest, opts ...scw.RequestOption) (*ExportKeyNameResponse, error) {
11691181
var err error
11701182

@@ -1205,8 +1217,12 @@ type ImportKeyNameRequest struct {
12051217
Name string `json:"name"`
12061218

12071219
PrivateKey string `json:"private_key"`
1220+
1221+
Value string `json:"value"`
12081222
}
12091223

1224+
// ImportKeyName: import your private key.
1225+
// Import a private key.
12101226
func (s *API) ImportKeyName(req *ImportKeyNameRequest, opts ...scw.RequestOption) (*Name, error) {
12111227
var err error
12121228

0 commit comments

Comments
 (0)