Document Existence of Web UI

[domenukk]

The most convenient way to test checkerlib is via the webui, however this feature is not well-documented in the readme.

[ldruschk]

Related to this, the stringify_spec_entry function should produce a valid JSON object such that the Web UI is usable without any adjustments:

enochecker/src/enochecker/checkerservice.py

Line 129 in 724f1ff

def stringify_spec_entry(entry: Union[Optional, Required]) -> str:

[domenukk]

Why and how? Stringify can't know what you want to do?

[ldruschk]

In that case the Web UI maybe shouldn't display the spec in the input field by default, but instead in addition to same valid example JSON. Personally I found it more confusing to have those optional fields with default values that lead to the JSON object being invalid when they could have just as well been filled with the default values.

[domenukk]

What should the default value for the address be?
Isn't it more important to know about available methods than to fill out one?
An extra field could be an option.

[ldruschk]

While you can't put in a default value for the address (although localhost and the port specified in the checker class might be a good guess), the rest of the defaults should be set such that specifying the address and method should be enough for most use cases.

[domenukk]

Address and method is enough for all use cases, the checkerlib sets sane defaults for all other values, if I recall correctly.

[domenukk]

See the spec:

enochecker/src/enochecker/checkerservice.py

Line 38 in d85a126

spec: List[Union[Required, Optional]] = [

Only the first two are marked Required.
This should probably also be documented.
(This makes it pretty easy to use via httpie on the commandline as well)

[ldruschk]

I think @MMunier has been doing some work on the Web UI recently

[ldruschk]

With the new web UI, would you consider this issue to be resolved? I would say the new interface is pretty self-explanatory

[MMunier]

Well some keys like the "UniqueVariantId" could use some onhover-texts, but I belive it is in a sufficient state to consider it done.

[domenukk]

With the new web UI, would you consider this issue to be resolved? I would say the new interface is pretty self-explanatory

It looks like this issue is more about "how do I spawn and access the checker web UI".
It still seems to very much not be documented. It could probably go into
https://github.com/enowars/enochecker/blob/main/docs/guide/developing.rst

[MMunier]

With the new web UI, would you consider this issue to be resolved? I would say the new interface is pretty self-explanatory

It looks like this issue is more about "how do I spawn and access the checker web UI".
It still seems to very much not be documented. It could probably go into
https://github.com/enowars/enochecker/blob/main/docs/guide/developing.rst

is it?
At least the discussion until here wasn't about that
And start your checker GET / isn't that big of a hurdle either

[domenukk]

That was Lucas' "related to this" sidetrack.
Knowing that there is a web ui in the first place couldn't hurt...

[domenukk]

I guess this is a subset of the newer #54 though, so closing