Skip to content

Latest commit

 

History

History

README.md

WebSocket Integration API

API HTML documentation

  • View with AsyncAPI Studio online tool.
    The link will directly load the yaml definition file from GitHub and display it together with the HTML documentation in the browser.

The AsyncAPI generator tool transforms the API definition into other formats.

The easiest way to generate the HTML documentation from the AsyncAPI definition is to use the official asyncapi/generator Docker image. You can also try to use the command line tool with the instructions provided from the generator tool. The provided Bash wrapper script create-html-docker.sh creates the html documentation in the ./html sub folder.

API Versions

Integration API UCR Firmware Core Simulator
0.15.1 0.70.4
0.13.0 2.8.0-beta 0.64.4
0.12.1 2.2.4-beta 0.58.3
0.12.0 1.9.3-beta 0.48.0
0.11.0 1.9.2-beta 0.47.0
0.10.0 1.7.12 0.43.0
0.9.0 1.7.2 0.41.0
0.8.0 1.5.2 0.39.7