Document Traffic Monitor API Fully

[rob05c]

The TM API has docs: https://traffic-control-cdn.readthedocs.io/en/latest/development/traffic_monitor/traffic_monitor_api.html

But they're incomplete, and not in a very visible place.

We should document all the endpoints. The endpoints are all linked from the monitor's HTTP page, they just need added to the docs.

We should also probably put the Monitor API docs in a more visible place. Maybe create a unified root "APIs" doc page, with links to the APIs of every component?

---

Endpoints to document: GET Endpoint	Status
/api/bandwidth-capacity-kbps	Undocumented
/api/bandwidth-kbps	Undocumented
/api/cache-available-count	Undocumented
/api/cache-count	Undocumented
/api/cache-down-count	Undocumented
/api/cache-statuses	Undocumented
/api/crconfig-history	Undocumented
/api/monitor-config	Undocumented
/api/traffic-ops-uri	Undocumented
/api/version	Undocumented
/publish/CacheStats	Documented response is inaccurate
/publish/CacheStats/{{hostname}}	Request path is incorrect: https://github.com/apache/trafficcontrol/blob/f64365c3f1bbf0e9bc35a9502279ca1e362a7ab8/docs/source/development/traffic_monitor/traffic_monitor_api.rst#L215
/publish/CacheStatsNew	Undocumented
/publish/ConfigDoc	Response is undocumented
/publish/CrConfig	Response is undocumented
/publish/CrStates	Response is undocumented
/publish/DsStats	Response is undocumented
/publish/DsStats/{{xmlId}}	Response is undocumented
/publish/EventLog	Response fields ipv4Available and ipv6Available are undocumented
/publish/PeerStates	Response is undocumented
/publish/Stats	Response is undocumented
/publish/StatSummary	Response is undocumented

[mitchell852]

is this still applicable @rob05c ? are there TM endpoints still not documented?

[ocket8888]

The TM API is partially and "unacceptably" (according to the guidelines) documented. Note that all of the endpoints listed still have their associated problems. So, yes.