api doc require parameters and corresponding updates to tests