CardanoSolutions/ogmios

Api reference to signpost health ep

Closed this issue · 0 comments

What is your idea? Provide a use case.

I spent all of 5 minutes scrolling up and down the API reference in the docs not understanding how to pull out the ogmios version from the extensive list of possible rpcs.

It is, of course, in the docs but under "getting started > monitoring".

Why is it a good idea?

When I forget this, and again go straight to the API reference, i'll be reminded its available as a rest ep.

What is the current alternative and why is it not good enough?

I spent a good 5 minutes being confused and that I was expected to have the read the docs from the beginning... :(