added more documentation for the api