How to peer review a core web service function
From MoodleDocs
This page is an help for peer-reviewer. Complete/modify it whenever you feel confuse. No-one else than you is going to do that, share you knowledge.
Who must peer-review a web service function
The component maintainer must peer-review her/his component web service function. Core web service functions require a full understanding of the component.
How to peer-review
Peer-reviewing is about checking all this list points. However here are some essential questions that you should be able to answer:
- is this function relevant? : does it make sens to call this function from an external client? Can you think of a use case? Is this function duplicating another web service function?
- are the parameters correct? Can they be used by external system? Are they well typed in the description?
- are the capabilities and other checks respecting 100% the web version?
- is the code logic matching 100% the web version? At best the code logic should be one core lib call, is it the case? How could we end up to it?
