Several documentation issues

[ebozduman]

There are several minio-py SDK documentation issues as listed below:

• Missing optional arguments and/or their default values in command titles:
  ..., request_headers = None) in get_object, get_partial_object, fget_object
  ..., copy_conditions= None) in copy_object
  ..., content_type= 'application/octet-stream', metadata = None) in put_object, fput_object
  Example:
  fput_object(bucket_name, object_name, file_path, content_type) => fput_object(bucket_name, object_name, file_path, content_type = 'application/octet-stream', metadata = None)

• Explanation for fput_object command argument file_path is wrong:
  | file_path | string | Path on the local filesystem to which the object data will be written.| =>
  | file_path | string | Path on the local filesystem from which object data will be read.|

• Optional argument, objectPrefix, is listed as mandatory argument for list_objects and list_objects_v2 commands. Fix is needed in the title and in the table as shown below:
  Title: list_objects(bucket_name, prefix= None, recursive=False)
  Title: list_objects_v2(bucket_name, prefix= None, recursive=False)
  Table:
  | objectPrefix | string | The prefix of the objects that should be listed.Optional, default is None.|

• Return value object for list_objects and list_objects_v2 commands have missing parameters in their Param tables:

Param	Type	Description
object.bucket_name	string	name of the bucket object resides in.
object.content_type	string	content-type of the object.
object.metadata	dict	contains any additional metadata on the object.
object.is_dir	bool	True if listed object is a dir (prefix) and False otherwise.

[ebozduman]

I have to finish the policy issue, #635, first since both this issue and #635 touch the same source file, API.md. I am almost done with the policy issue, currrently working on the mint testing affected by the
policy fix.

[nitisht]

@ebozduman can this be closed now?

[ebozduman]

Yes. Please close it.