home-assistant / developers.home-assistant

Developers website for Home Assistant.
https://developers.home-assistant.io
Other
314 stars 966 forks source link

Documentation for the REST API /services endpoint is incorrect/incomplete #2419

Open korfuri opened 1 month ago

korfuri commented 1 month ago

I was recently looking at the REST API for Home Assistant and while trying out the /services endpoint I noticed that the responses I get from my HA instance are quite different from the documented format at https://developers.home-assistant.io/docs/api/rest/

The documented format is pretty trivial, only listing service names. The actual format I observed is more self-describing and complete, where services is a dictionary of service objects, These typically include a fields field, whose schema is unclear from just observing the responses. It looks like the format is complete enough to allow clients to build a dynamic UI to control each service so I assume it's quite complete. Is this documented anywhere? Maybe it would be possible to link that from the REST API documentation?

Thanks!