Brandon Keepers - I'm working on new API docs t...
I'm working on new API docs that will replace the built-in server docs. You can browse a WIP build here[1]. There's still a lot of work to do (especially to clean up the generated API docs), but I'd love feedback on the PR[2].
Specifically, I am focusing my attention around Plugin [3], and ServerAPI [4], but open to any and all suggestions.
[1]: https://opensoul.org/signalk-server/
[2]: https://github.com/SignalK/signalk-server/pull/1914
[3]: https://opensoul.org/signalk-server/_signalk/server-api/Plugin/
[4]: https://opensoul.org/signalk-server/_signalk/server-api/ServerAPI/
4 Replies
👍
there are many branded strings like SourceRef, but the docs don't show that they are actually strings underneath. but is it enough that your IDE tells you that?
Interesting. I'll look into it.
I made a change that will at least show the type declaration, so that helps a little. I added some docs for
Brand as well. https://opensoul.org/signalk-server/_signalk/server-api/Brand/
Honestly not sure I love the use of Branded types for a public API like this.