finish documentation for api review
### Tests
- [ ] Function code is fully covered by tests
- - [ ] check if we can remove uncovered code
- TODO
+ - [x] check if we can remove uncovered code
- [x] Line 542
- [ ] All possible error states are covered by tests
- [x] add test case for read-only key
