Node Monitoring API Docs are unpolished

[Anviking]

Release	Operating System	Cause
next	Windows & OSX & Linux)	Code

Context

In addition to the wallet api docs, there is also the node monitoring api docs.

Steps to Reproduce

1. launch wallet

stack exec -- cardano-wallet-server \                            
    --node-id                    edge                                   \
    --system-start               0                                      \
                                                                                                             \
    --topology                   state-integration/topology/edge.json   \
    --configuration-file         test/integration/configuration.yaml    \
                                                                                                             \
    --db-path                    state-integration/db                   \
     --wallet-db-path             state-integration/wallet-db            \
    --wallet-rebuild-db                                                 \
                                                                                                             \
    --wallet-api-address         127.0.0.1:8090                         \
    --wallet-doc-address         127.0.0.1:8190                         \
    --node-api-address           127.0.0.1:8080                         \
    --node-doc-address           127.0.0.1:8180                         \
                                                                                                             \
    --tls-ca-cert                state-integration/tls/edge/ca.crt      \
    --tls-wallet-server-cert     state-integration/tls/edge/server.crt  \
    --tls-wallet-server-key      state-integration/tls/edge/server.key  \
    --tls-node-client-cert       state-integration/tls/edge/client.crt  \
    --tls-node-client-key        state-integration/tls/edge/client.key  \

Visit https://127.0.0.1:8180/docs/v1/index/#tag/Info

Expected behavior

Nice docs

Actual behavior

• The purpose of utxo, confirmed-proposals is unclear
• Very sparse documentation on the other endpoints too
• <no description> is written on utxo, confirmed-proposals
• next-update, restart-node lack tags, which breaks the links to specific locations (e.g https://127.0.0.1:8180/docs/v1/index/#null%2Fpaths%2F~1api~1v1~1next-update%2Fget, notice the #null)

---

Resolution Plan

• [x] Propose a fix of any kind
• [ ] Check if we need to keep the "legacy" node api
• [ ] Check if how we want to group endpoints into tags

PR

Number	Base
input-output-hk/cardano-sl#4072	develop

QA

[Anviking]

So we could do either:

or

🤔

[akegalj]

• notice the #null

:man_facepalming:

[Anviking]

@KtorZ your advice would be helpful here

Particularly if we

• could do something with / remove the legacy api
  • should have many tags or one tag (see pictures in comment above)

[KtorZ]

Also, there's no real "legacy" node API (we've already cleaned that out and kept what was useful for ops). The API isn't perfect as it is to be 100% fair, and @cleverca22 already communicated on a few points they'd change.

Yet, we won't likely be spending any time on that. So, fixing the doc to better reflect what the API currently is, is the best we can do. About the tags, what would you do @Anviking ?