Bug: Improve developer documentation (Learnocaml_api.request)

[erikmd]

Related project scope(s): REST API

Related user(s):

• @cesclass
• @erikmd

Bug description

The dev. doc. (comments, etc.) of some parts of the codebase (§) is terse and should be extended to ease contributing.

(§) Namely, each constructor of Learnocaml_api.request should come with a summary of its operational semantics:

learn-ocaml/src/state/learnocaml_api.mli

Lines 80 to 93 in dd16e46

	type _ request =
	| Static:
	string list -> string request
	| Version:
	unit -> (string * int) request
	| Nonce:
	unit -> string request
	| Create_token:
	string * student token option * string option -> student token request
	| Create_teacher_token:
	teacher token -> teacher token request
	| Fetch_save:
	'a token -> Save.t request
	| Archive_zip:

…

Current configuration

• OS name (and version): N/A
• Browser name (and version): N/A
• learn-ocaml --version: master = dd16e46
• git describe --long --always --abbrev=40 --tags: