add a bit of api documentation