Keep API docs up to date with recent changes #847
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
deekoder
requested review from
balamurugana,
deekoder and
harshavardhana
and removed request for
deekoder
balamurugana
requested changes
Oct 12, 2017
docs/API.md
Outdated
| @@ -935,7 +936,7 @@ if err != nil { | |||
| } | |||
| ``` | |||
| <a name="RemoveObjects"></a> | |||
| ### RemoveObjects(bucketName string, objectsCh chan string) errorCh chan minio.RemoveObjectError | |||
| ### RemoveObjects(bucketName string, objectsCh chan string) errorCh chan RemoveObjectError | |||
There was a problem hiding this comment.
minio. is missed in RemoveObjectError and supposes to be <-chan minio.RemoveObjectError only
balamurugana
approved these changes
Oct 13, 2017
harshavardhana
requested changes
Oct 13, 2017
There was a problem hiding this comment.
Some more areas that need fixing
topicArn := minio.NewArn("aws", "sns", "us-east-1", "804605494417", "PhotoUpdate")
topicConfig := minio.NewNotificationConfig(topicArn)
topicConfig.AddEvents(minio.ObjectCreatedAll, minio.ObjectRemovedAll)
lambdaConfig.AddFilterPrefix("photos/") ---> Here should be topicConfig
lambdaConfig.AddFilterSuffix(".jpg") ---> Here should be topicConfig
bucketNotification := minio.BucketNotification{}
bucketNotification.AddTopic(topicConfig)
err := c.SetBucketNotification(bucketName, bucketNotification)
if err != nil {
fmt.Println("Unable to set the bucket notification: " + err) ---> Here!
}
harshavardhana
requested changes
Oct 14, 2017
| @@ -935,7 +936,7 @@ if err != nil { | |||
| } | |||
| ``` | |||
| <a name="RemoveObjects"></a> | |||
| ### RemoveObjects(bucketName string, objectsCh chan string) errorCh chan minio.RemoveObjectError | |||
| ### RemoveObjects(bucketName string, objectsCh chan string) (errorCh <-chan RemoveObjectError) | |||
There was a problem hiding this comment.
minio.RemoveObjectError?
harshavardhana
approved these changes
Oct 16, 2017
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #844, #845 and other documentation inconsistencies.