Public APIs like this should always have a documentation, please refer to other examples in this class, and make the documentation as complete as you can possibly make it.

Also, we need to write test case(s) for this new API, both positive and negative test cases. The pull request won't be accepted unless there is test case written for it.