updated docs
Change-Id: Iab1bd8f31d251c85a8a0c68ce880bfad9c5f9b98
diff --git a/docs/swagger/bbsim/bbsim.swagger.json b/docs/swagger/bbsim/bbsim.swagger.json
index 951d187..d4130f1 100644
--- a/docs/swagger/bbsim/bbsim.swagger.json
+++ b/docs/swagger/bbsim/bbsim.swagger.json
@@ -13,6 +13,7 @@
"paths": {
"/v1/olt": {
"get": {
+ "summary": "Get current status of OLT",
"operationId": "GetOlt",
"responses": {
"200": {
@@ -20,6 +21,12 @@
"schema": {
"$ref": "#/definitions/bbsimOlt"
}
+ },
+ "default": {
+ "description": "An unexpected error response",
+ "schema": {
+ "$ref": "#/definitions/runtimeError"
+ }
}
},
"tags": [
@@ -29,6 +36,7 @@
},
"/v1/olt/flows": {
"get": {
+ "summary": "Get all flows or ONU specific flows",
"operationId": "GetFlows2",
"responses": {
"200": {
@@ -36,6 +44,12 @@
"schema": {
"$ref": "#/definitions/bbsimFlows"
}
+ },
+ "default": {
+ "description": "An unexpected error response",
+ "schema": {
+ "$ref": "#/definitions/runtimeError"
+ }
}
},
"parameters": [
@@ -53,6 +67,7 @@
},
"/v1/olt/onus": {
"get": {
+ "summary": "Get status of all ONUs",
"operationId": "GetONUs",
"responses": {
"200": {
@@ -60,6 +75,54 @@
"schema": {
"$ref": "#/definitions/bbsimONUs"
}
+ },
+ "default": {
+ "description": "An unexpected error response",
+ "schema": {
+ "$ref": "#/definitions/runtimeError"
+ }
+ }
+ },
+ "tags": [
+ "BBSim"
+ ]
+ },
+ "delete": {
+ "summary": "Shutdown all ONUs in OLT",
+ "operationId": "ShutdownAllONUs",
+ "responses": {
+ "200": {
+ "description": "A successful response.",
+ "schema": {
+ "$ref": "#/definitions/bbsimResponse"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response",
+ "schema": {
+ "$ref": "#/definitions/runtimeError"
+ }
+ }
+ },
+ "tags": [
+ "BBSim"
+ ]
+ },
+ "post": {
+ "summary": "Poweron all ONUs in OLT",
+ "operationId": "PoweronAllONUs",
+ "responses": {
+ "200": {
+ "description": "A successful response.",
+ "schema": {
+ "$ref": "#/definitions/bbsimResponse"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response",
+ "schema": {
+ "$ref": "#/definitions/runtimeError"
+ }
}
},
"tags": [
@@ -69,6 +132,7 @@
},
"/v1/olt/onus/{SerialNumber}": {
"get": {
+ "summary": "Get status of an ONU by serial number",
"operationId": "GetONU",
"responses": {
"200": {
@@ -76,6 +140,12 @@
"schema": {
"$ref": "#/definitions/bbsimONU"
}
+ },
+ "default": {
+ "description": "An unexpected error response",
+ "schema": {
+ "$ref": "#/definitions/runtimeError"
+ }
}
},
"parameters": [
@@ -91,6 +161,7 @@
]
},
"delete": {
+ "summary": "Shutdown an ONU by serial number",
"operationId": "ShutdownONU",
"responses": {
"200": {
@@ -98,6 +169,12 @@
"schema": {
"$ref": "#/definitions/bbsimResponse"
}
+ },
+ "default": {
+ "description": "An unexpected error response",
+ "schema": {
+ "$ref": "#/definitions/runtimeError"
+ }
}
},
"parameters": [
@@ -113,6 +190,7 @@
]
},
"post": {
+ "summary": "Poweron an ONU by serial number",
"operationId": "PoweronONU",
"responses": {
"200": {
@@ -120,6 +198,12 @@
"schema": {
"$ref": "#/definitions/bbsimResponse"
}
+ },
+ "default": {
+ "description": "An unexpected error response",
+ "schema": {
+ "$ref": "#/definitions/runtimeError"
+ }
}
},
"parameters": [
@@ -137,6 +221,7 @@
},
"/v1/olt/onus/{SerialNumber}/alarms/{AlarmType}/{Status}": {
"post": {
+ "summary": "Send ONU alarm indication",
"operationId": "SetOnuAlarmIndication",
"responses": {
"200": {
@@ -144,6 +229,12 @@
"schema": {
"$ref": "#/definitions/bbsimResponse"
}
+ },
+ "default": {
+ "description": "An unexpected error response",
+ "schema": {
+ "$ref": "#/definitions/runtimeError"
+ }
}
},
"parameters": [
@@ -173,6 +264,7 @@
},
"/v1/olt/onus/{SerialNumber}/flows": {
"get": {
+ "summary": "Get all flows or ONU specific flows",
"operationId": "GetFlows",
"responses": {
"200": {
@@ -180,6 +272,12 @@
"schema": {
"$ref": "#/definitions/bbsimFlows"
}
+ },
+ "default": {
+ "description": "An unexpected error response",
+ "schema": {
+ "$ref": "#/definitions/runtimeError"
+ }
}
},
"parameters": [
@@ -197,6 +295,7 @@
},
"/v1/olt/onus/{SerialNumber}/trafficschedulers": {
"get": {
+ "summary": "Get Traffic scheduler information for ONU",
"operationId": "GetOnuTrafficSchedulers",
"responses": {
"200": {
@@ -204,6 +303,12 @@
"schema": {
"$ref": "#/definitions/bbsimONUTrafficSchedulers"
}
+ },
+ "default": {
+ "description": "An unexpected error response",
+ "schema": {
+ "$ref": "#/definitions/runtimeError"
+ }
}
},
"parameters": [
@@ -219,8 +324,71 @@
]
}
},
+ "/v1/olt/port/{PonPortId}/onus": {
+ "delete": {
+ "summary": "Shutdown all ONUs under a PON by pon-port-ID",
+ "operationId": "ShutdownONUsOnPON",
+ "responses": {
+ "200": {
+ "description": "A successful response.",
+ "schema": {
+ "$ref": "#/definitions/bbsimResponse"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response",
+ "schema": {
+ "$ref": "#/definitions/runtimeError"
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "PonPortId",
+ "in": "path",
+ "required": true,
+ "type": "integer",
+ "format": "int64"
+ }
+ ],
+ "tags": [
+ "BBSim"
+ ]
+ },
+ "post": {
+ "summary": "Poweron all ONUs under a PON by pon-port-ID",
+ "operationId": "PoweronONUsOnPON",
+ "responses": {
+ "200": {
+ "description": "A successful response.",
+ "schema": {
+ "$ref": "#/definitions/bbsimResponse"
+ }
+ },
+ "default": {
+ "description": "An unexpected error response",
+ "schema": {
+ "$ref": "#/definitions/runtimeError"
+ }
+ }
+ },
+ "parameters": [
+ {
+ "name": "PonPortId",
+ "in": "path",
+ "required": true,
+ "type": "integer",
+ "format": "int64"
+ }
+ ],
+ "tags": [
+ "BBSim"
+ ]
+ }
+ },
"/v1/olt/ports/{InterfaceType}/{InterfaceID}/alarms/los/{Status}": {
"post": {
+ "summary": "Send OLT alarm indication for Interface type NNI or PON",
"operationId": "SetOltAlarmIndication",
"responses": {
"200": {
@@ -228,6 +396,12 @@
"schema": {
"$ref": "#/definitions/bbsimResponse"
}
+ },
+ "default": {
+ "description": "An unexpected error response",
+ "schema": {
+ "$ref": "#/definitions/runtimeError"
+ }
}
},
"parameters": [
@@ -258,6 +432,7 @@
},
"/v1/olt/status": {
"get": {
+ "summary": "Get current status of OLT",
"operationId": "GetOlt2",
"responses": {
"200": {
@@ -265,6 +440,12 @@
"schema": {
"$ref": "#/definitions/bbsimOlt"
}
+ },
+ "default": {
+ "description": "An unexpected error response",
+ "schema": {
+ "$ref": "#/definitions/runtimeError"
+ }
}
},
"tags": [
@@ -274,6 +455,7 @@
},
"/v1/version": {
"get": {
+ "summary": "Get BBSim version",
"operationId": "Version",
"responses": {
"200": {
@@ -281,6 +463,12 @@
"schema": {
"$ref": "#/definitions/bbsimVersionNumber"
}
+ },
+ "default": {
+ "description": "An unexpected error response",
+ "schema": {
+ "$ref": "#/definitions/runtimeError"
+ }
}
},
"tags": [
@@ -654,6 +842,39 @@
}
}
},
+ "protobufAny": {
+ "type": "object",
+ "properties": {
+ "type_url": {
+ "type": "string"
+ },
+ "value": {
+ "type": "string",
+ "format": "byte"
+ }
+ }
+ },
+ "runtimeError": {
+ "type": "object",
+ "properties": {
+ "error": {
+ "type": "string"
+ },
+ "code": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "message": {
+ "type": "string"
+ },
+ "details": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/protobufAny"
+ }
+ }
+ }
+ },
"tech_profileAdditionalBW": {
"type": "string",
"enum": [