Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: fix bucket and object API doc #189

Merged
merged 6 commits into from
Sep 21, 2023
Merged

fix: fix bucket and object API doc #189

merged 6 commits into from
Sep 21, 2023

Conversation

flywukong
Copy link
Collaborator

@flywukong flywukong commented Sep 20, 2023

Description

fix bucket and object API doc

Rationale

tell us why we need these changes...

Example

add an example CLI or API response...

Changes

Notable changes:

  • add each change in a bullet point here
  • ...

@flywukong flywukong changed the title Fix bucket doc fix: fix bucket doc Sep 20, 2023
@flywukong flywukong changed the base branch from develop to doc-refactor September 20, 2023 09:47
@flywukong flywukong changed the title fix: fix bucket doc fix: fix bucket and object API doc Sep 21, 2023
@@ -184,7 +191,17 @@ func (c *Client) CreateBucket(ctx context.Context, bucketName string, primaryAdd
return txnHash, nil
}

// DeleteBucket send DeleteBucket txn to greenfield chain and return txn hash
// DeleteBucket - Sends DeleteBucket msg to greenfield chain and return txn hash.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sends -> Send

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

@KeefeL KeefeL merged commit 36b54db into doc-refactor Sep 21, 2023
1 check passed
KeefeL pushed a commit that referenced this pull request Sep 21, 2023
* docs: refine the comments of bucket api

* docs: update metadata list apis and option.go

* doc: improve the comments of bucket api

* fix: fix the object api comments

* fix: fix the object interface

---------

Co-authored-by: BarryTong65 <barrytong.work@gmail.com>
github-merge-queue bot pushed a commit that referenced this pull request Sep 21, 2023
* docs: refactor for adding comments

* docs: refine Basic, Group, SP, VG Clients and types.go documentation. (#184)

* doc: refactor for adding comments

* Refine Basic, Group, SP, VG, and types.go documentation.

* fix format

* enrich comments

---------

Co-authored-by: Keefe Liu <keefe.l@users.noreply.github.com>

* docs: refine the go doc of the cross-chain related apis (#187)

* docs: refine the go doc of the cross-chain related apis

* fix comment

* docs: refine the go doc of payment apis (#185)

* doc: refine the go doc of payment apis

* doc: refine the go doc of payment apis

* fix review comments

* docs: refine the go doc of validator/staking apis (#186)

* docs: refine the go doc of validator/staking apis

* fix review comments

* fix: fix bucket and object API doc (#189)

* docs: refine the comments of bucket api

* docs: update metadata list apis and option.go

* doc: improve the comments of bucket api

* fix: fix the object api comments

* fix: fix the object interface

---------

Co-authored-by: BarryTong65 <barrytong.work@gmail.com>

* fix: go-sdk doc for off chain auth (#190)

* fix: go-sdk doc for off chain auth

* fix: go-sdk doc for off chain auth - adding input description.

---------

Co-authored-by: Clyde <clyde.m@nodereal.io>

* docs: refine the go doc of challenge apis (#183)

* doc: refine the go doc of challenge apis

* doc: refine the go doc of challenge apis

* fix review comments

---------

Co-authored-by: Keefe Liu <keefe.l@users.noreply.github.com>

* fix: fix e2e (#192)

* docs: add comments for the account file

* fix: fix list.go comment (#194)

* fix: fix list.go comment (#197)

* fix: fix group api (#198)

---------

Co-authored-by: Keefe Liu <keefe.l@users.noreply.github.com>
Co-authored-by: Alexxxxxx <118710506+alexgao001@users.noreply.github.com>
Co-authored-by: yutianwu <wzxingbupt@gmail.com>
Co-authored-by: forcodedancing <just.haha.it@gmail.com>
Co-authored-by: flywukong <2229306838@qq.com>
Co-authored-by: BarryTong65 <barrytong.work@gmail.com>
Co-authored-by: ruojunm <46366167+ruojunm@users.noreply.github.com>
Co-authored-by: Clyde <clyde.m@nodereal.io>
Co-authored-by: Barry <122767193+BarryTong65@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants