poc api2

[canonici]

No description provided.

[ilankri]

It is on the right track! The naming of the Protobuf messages and OCaml functions might need to be adjusted later.

[ilankri]

The fields are optional to ease the switch to Proto3?

[canonici]

In part, but even if there is never a switch to Proto3, it can cause many issues.

https://protobuf.dev/programming-guides/proto2/#required-deprecated

[ilankri]

Maybe we should have two distinct messages RequestByIndex and RequestByNpocc? To avoid this:

geneweb-plugin-api/src/request.ml

Lines 15 to 21 in 3ca3ecd

	let person_select_of_piqi_request piqi_request =
	let requested_index = piqi_request.Api_v2_piqi.Request.index in
	let requested_npocc = piqi_request.Api_v2_piqi.Request.npocc in
	match requested_index, requested_npocc with
	| Some index, _ -> Some (Common.Index index)
	| _, Some Api_v2_piqi.Npocc.{n = Some n; p = Some p; occ = Some occ} -> Some (Common.Npocc {n; p; occ})
	| _, _ -> None

[canonici]

we can, but that means two different endpoints, which is not an issue in itself. It would then be on the client to ask the right one.

[ilankri]

Suggested change

	if person.fields.image then
	Api_util.get_portrait person.conf person.base person.person
	else None
	Ext_option.return_if person.fields.image (fun () ->
	Api_util.get_portrait person.conf person.base person.person
	)

[ilankri]

Suggested change

	if person.confidentiality.restricted then None
	else
	Option.bind fields (fun fields ->
	Option.bind (Gwdb.get_parents person.person) (fun parents ->
	let iparent = proj (Gwdb.foi person.base parents) in
	let parent = Gwdb.poi person.base iparent in
	Option.some (of_person person.conf person.base fields parent))
	)
	Ext_option.return_if (not person.confidentiality.restricted (fun () ->
	Option.bind fields (fun fields ->
	Option.bind (Gwdb.get_parents person.person) (fun parents ->
	let iparent = proj (Gwdb.foi person.base parents) in
	let parent = Gwdb.poi person.base iparent in
	Option.some (of_person person.conf person.base fields parent))
	)
	)

[ilankri]

?!

[ilankri]

Suggested change

	elements_per_page : int;
	elements_per_page : [ `Int of int | `All ] ;

[ilankri]

Suggested change

	if not (has_visible_names person) then None
	else
	of_field person.fields.npocc (fun person' ->
	let lowered_string proj person = Name.lower (as_string proj person) in
	{
	n = lowered_string Gwdb.get_first_name person;
	p = lowered_string Gwdb.get_surname person;
	occ = Int32.of_int (Gwdb.get_occ person');
	}
	) person
	Ext_option.return_if (has_visible_names person) (fun () ->
	of_field person.fields.npocc (fun person' ->
	let lowered_string proj person = Name.lower (as_string proj person) in
	{
	n = lowered_string Gwdb.get_first_name person;
	p = lowered_string Gwdb.get_surname person;
	occ = Int32.of_int (Gwdb.get_occ person');
	}
	) person
	)

[ilankri]

Suggested change

	(*let as_some_string ?(none_if_empty = false) proj person =
	let s = as_string proj person in
	Ext_option.return_if (not none_if_empty || s <> "") (fun () -> s)*)