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