diff options
author | 2020-08-04 09:51:02 +0000 | |
---|---|---|
committer | 2020-08-04 11:39:06 +0000 | |
commit | fb82ba422b4416269cb7e894d84ebafe0f75167c (patch) | |
tree | b7fcbdc9f1ba6a488c528c0698a7e49dc5cf9b6a /docs/sections/swaggerdoc/oof-osdf-has-api.json | |
parent | a0bef7e64e5ec4b81867cf310a293b6fa144e0f3 (diff) |
Updated Swagger doc for the Inter Domain
Route API
Change-Id: Iffb9f176eb0490459aed4d78945b5c3bf342528b
Issue-ID: OPTFRA-820
Signed-off-by: Mehreen Kaleem <mehreen.kaleem@us.fujitsu.com>
Diffstat (limited to 'docs/sections/swaggerdoc/oof-osdf-has-api.json')
-rw-r--r-- | docs/sections/swaggerdoc/oof-osdf-has-api.json | 174 |
1 files changed, 173 insertions, 1 deletions
diff --git a/docs/sections/swaggerdoc/oof-osdf-has-api.json b/docs/sections/swaggerdoc/oof-osdf-has-api.json index ec5d003..bbe0667 100644 --- a/docs/sections/swaggerdoc/oof-osdf-has-api.json +++ b/docs/sections/swaggerdoc/oof-osdf-has-api.json @@ -407,9 +407,181 @@ } } } - } + }, + "/api/oof/mdons/route/v1": { + "post": { + "tags": [ + "Inter Domain Route Select" + ], + "summary":"Find the optimistic inter domain route for multi domain optical system", + "description":"", + "operationId":"getInterDomainRoute", + "consumes": [ + "application/json" + ], + "produces":[ + "application/json" + ], + "parameters":[ + { + "in":"body", + "name":"body", + "description":"Source and Destination interfaces across which optmistic route have to be obtained.", + "required":true, + "schema":{ + "$ref":"#/definitions/InterDomainRouteRequest" + } + } + ], + "responses":{ + "200":{ + "description":"successful operation", + "schema":{ + "$ref":"#/definitions/InterDomainRouteResponseBody" + } + }, + "400":{ + "description":"bad request" + }, + "401":{ + "description":"Request body is not compliant with the API definition" + }, + "404":{ + "description":"The server cannot find the requested URI" + }, + "405":{ + "description":"The requested method is not supported by a server." + }, + "500":{ + "description":"The server encountered an internal server error or timed out" + } + } + } + } }, "definitions": { + "InterDomainRouteRequest":{ + "type":"object", + "properties":{ + "requestInfo":{ + "$ref":"#/definitions/requestInfo" + }, + "routeInfo":{ + "$ref":"#/definitions/interDomainRouteInfo" + } + } + }, + "interDomainRouteInfo":{ + "type":"object", + "properties":{ + "routeRequest":{ + "$ref":"#/definitions/interDomainRouteRequest" + } + } + }, + "interDomainRouteRequest":{ + "type":"object", + "properties":{ + "srcDetails":{ + "$ref":"#/definitions/interDomainPortDetails" + }, + "dstDetails":{ + "$ref":"#/definitions/interDomainPortDetails" + }, + "serviceRate":{ + "type":"string", + "description":"The rate of the service." + } + } + }, + "interDomainPortDetails":{ + "type":"object", + "properties":{ + "interfaceId":{ + "type":"string", + "description":"The port id." + }, + "nodeId":{ + "type":"string", + "description":"The node id." + }, + "controllerId":{ + "type":"string", + "description":"The controller id to which the node belongs to." + } + } + }, + "InterDomainRouteResponseBody":{ + "type":"object", + "properties":{ + "requestId":{ + "type":"string", + "description":"A unique Id for an ONAP transaction." + }, + "transactionId":{ + "type":"string", + "description":"A unique ID to track multiple requests associated with a transaction." + }, + "statusMessage":{ + "type":"string", + "description":"Reasoning if a requestStatus is failure." + }, + "requestStatus":{ + "type":"string", + "description":"The status of a request." + }, + "solutions":{ + "$ref":"#/definitions/InterDomainRouteSolutionInfo" + } + } + }, + "InterDomainRouteSolutionInfo":{ + "type":"object", + "properties":{ + "routeInfo":{ + "$ref":"#/definitions/interDomainResponseRouteinfo" + } + } + }, + "interDomainResponseRouteinfo":{ + "type":"object", + "properties":{ + "serviceRoute":{ + "type":"array", + "items":{ + "$ref":"#/definitions/serviceRouteDetails" + } + }, + "linkList":{ + "type":"array", + "items":{ + "type":"string" + }, + "description":"A list of link names of the route.", + "example":[ + "link1", + "link2" + ] + } + } + }, + "serviceRouteDetails":{ + "type":"object", + "properties":{ + "srcInterfaceId":{ + "type":"string", + "description":"Source port Id of the domain Service." + }, + "dstInterfaceId":{ + "type":"string", + "description":"Destination Port Id of the domain Service." + }, + "controllerId":{ + "type":"string", + "description":"Controller Id of the domain." + } + } + }, "RouteRequest": { "type": "object", "properties": { |