blob: c44cec403de2088619c6ad53e6853dbd67ab8821 [file] [log] [blame]
Zdravko Bozakov2da76342019-10-21 09:47:35 +02001.. _BBSimAPI:
2
Matteo Scandolof380a972020-09-11 12:09:40 -07003REST APIs
4=========
5
Zdravko Bozakov2da76342019-10-21 09:47:35 +02006BBSimAPI
7--------
8
Zack Williams4b0ef4d2019-12-18 14:25:20 -07009BBSim exposes gRPC and REST APIs for external control of the simulated OLT. The
10API is defined using the protocol buffer specification in
11`api/bbsim/bbsim.proto`.
12
13By default, the gRPC server is started on port 50070 and the REST server is
14started on port 50071. The following endpoints are currently defined:
Zdravko Bozakov2da76342019-10-21 09:47:35 +020015
16.. openapi:: ../swagger/bbsim/bbsim.swagger.json
17
18Legacy BBSimAPI
19---------------
20
Zack Williams4b0ef4d2019-12-18 14:25:20 -070021Additionally, a legacy API is available, defined in `api/legacy/bbsim.proto`.
22This API is deprecated and will be removed once BBSim reaches feature parity
23with the legacy version.
24
25By default, the legacy gRPC server is started on port 50072 and the
26corresponding REST server is started on port 50073. The following endpoints are
27currently defined:
Zdravko Bozakov2da76342019-10-21 09:47:35 +020028
Matteo Scandolof380a972020-09-11 12:09:40 -070029.. openapi:: ../swagger/legacy/bbsim.swagger.json