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
Add doc for GetObjectOptions and PutObjectOptions #851
Conversation
|:--- |:--- | :--- | | ||
| `opts.UserMetadata` | _map[string]string_ | Map of user metadata| | ||
| `opts.Progress` | _io.Reader_ | Reader to fetch progress of an upload | | ||
| `opts.ContentType` | _string_ | Content type of object, e.g "application/text" | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there an exhaustive list of values that can be shown application/text, application/zip ....
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We can add a link here https://en.wikipedia.org/wiki/Media_type we don't need to write exhaustive list here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Basically meaning there is no restriction this ContentType field is HTTP Content-Type header with any value, we can mention that as well.
@@ -524,7 +530,7 @@ __Parameters__ | |||
|`bucketName` | _string_ |Name of the bucket | | |||
|`objectName` | _string_ |Name of the object | | |||
|`filePath` | _string_ |Path to download object to | | |||
|`materials` | _encrypt.Materials_ | The module to decrypt the object data | | |||
|`materials` | _encrypt.Materials_ | Interface provided by `encrypt` package to encrypt a stream of data (For more information see https://godoc.org/github.com/minio/minio-go) | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Need to update examples to show how to use with the encrypt option.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
AFAICS these are under FPutEncryptedObject() and FGetEncryptedObject.
|:--- |:--- | :--- | | ||
| `opts.UserMetadata` | _map[string]string_ | Map of user metadata| | ||
| `opts.Progress` | _io.Reader_ | Reader to fetch progress of an upload | | ||
| `opts.ContentType` | _string_ | Content type of object, e.g "application/text" | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
can we show all exhaustive values not just eg. What all content types can the api accept application/zip, application/octet. application/zip etc.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same as above.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ok then.
No description provided.