| Zdravko Bozakov | 2da7634 | 2019-10-21 09:47:35 +0200 | [diff] [blame] | 1 | .. _BBSimAPI: |
| 2 | |
| 3 | BBSimAPI |
| 4 | -------- |
| 5 | |
| 6 | BBSim exposes gRPC and REST APIs for external control of the simulated OLT. The API is defined using the protocol buffer specification in `api/bbsim/bbsim.proto`. |
| 7 | By default, the gRPC server is started on port 50070 and the REST server is started on port 50071. The following endpoints are currently defined: |
| 8 | |
| 9 | .. openapi:: ../swagger/bbsim/bbsim.swagger.json |
| 10 | |
| 11 | Legacy BBSimAPI |
| 12 | --------------- |
| 13 | |
| 14 | Additionally, a legacy API is available, defined in `api/legacy/bbsim.proto`. This API is deprecated and will be removed once BBSim reaches feature parity with the legacz version. |
| 15 | By default, the legacy gRPC server is started on port 50072 and the corresponding REST server is started on port 50073. The following endpoints are currently defined: |
| 16 | |
| 17 | .. openapi:: ../swagger/legacy/bbsim.swagger.json |